acedGetInput

C++

template <size_t nBufLen> inline int acedGetInput(
    wchar_t (& buf)[nBufLen]
);

File

acedads.h

Description

Deprecated. Retrieves a keyword entered by the AutoCAD user during a call to one of the user-input functions (acedGetxxx(), acedEntSel(), acedNEntSelP(), acedNEntSel(), or acedDragGen()).

Function acedGetInput() truncates any characters beyond 131 characters in the user's input and returns at most 132 characters in str (position 132 is reserved for the null character).

A call to acedGetInput() is meaningless and will fail unless it immediately follows a call to one of the user-input functions. Even then, the call will be successful only if the user-input function has returned the value RTKWORD (or RTSTR, in the case of acedDragGen()).

It isn't necessary to call acedGetInput() after a call to acedGetKword().

The keywords recognized by the ARX application are specified by a prior call to acedInitGet(). The interpretation of the keywords is entirely up to the application. Keywords should not duplicate the names of AutoCAD commands.

The user can abbreviate a keyword, but acedGetInput() always returns the full keyword as it was defined in the acedInitGet() call with the original capitalization, so the application needs to do only one string comparison for each keyword it defines.

The acedGetInput() function also retrieves arbitrary input, if that input was enabled by a prior acedInitGet() call that specified the RSG_OTHER bit. (If RSG_OTHER is enabled before an acedDragGen() call, acedDragGen() indicates that it has received arbitrary input by returning RTSTR instead of RTKWORD.)

If acedGetInput() succeeds, it returns RTNORM; otherwise, it returns RTERROR. 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().

Parameters

Use Instead

ACCORE_PORT int acedGetInput(AcString & sOut);