acedGetKword

C++

ACCORE_PORT int acedGetKword(
    const ACHAR * prompt, 
    AcString & sResult
);

File

acedads.h

Description

Gets user input for a keyword.

The AutoCAD user can enter the keyword from the keyboard. The list of keywords that acedGetKword() accepts is set by a prior call to acedInitGet(). If the user enters a string not specified in the call to acedInitGet(), AutoCAD displays an error message and tries again (and redisplays prompt, if one was specified). If the user types only [Return], acedGetKword() returns an empty string ("") unless the call to acedInitGet() also disallowed null input.

The user cannot respond to acedGetKword() by entering an AutoLISP expression.

The acedGetKword() function does not return RTKWORD. The RTKWORD value is used only as a status (or error) code that is returned by other user-input (acedGetXxx()) functions such as acedGetInt().

The acedGetKword() function returns one of the following: RTNORM if it succeeds, RTERROR if it fails, or RTCAN if the user cancels the request (by pressing [ESC]). It returns RTMODELESS, if the active command was registered using the ACRX_CMD_INTERRUPTIBLE flag and the document has received a modeless interrupt signal from a call to AcApDocManager::sendModelessInterrupt(). The prior call to acedInitGet() can also enable a return value of RTNONE (if the user enters a null response or arbitrary input).

Parameters