acedGetSym

C++

int acedGetSym(
    const ACHAR * sname, 
    struct resbuf ** value
);

File

acedads.h

Description

Retrieves the value of a bound AutoLISP symbol.

This function can be used in the ARX program environment only when AutoCAD sends the message kInvkSubrMsg to the application.

If the AutoLISP symbol is bound to a value of a type that can't be represented by a list of ARX result buffers (such as a subr or exsubr), the acedGetSym() call fails. If the symbol is not found or is nil, acedGetSym() returns RTNORM and sets the contents of value (*value) to null.

The acedGetSym() function returns RTNORM if it succeeds and RTERROR if it fails. 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(). When acedGetSym() fails, it sets the system variable ERRNO to a value that indicates the reason for the failure.

Parameters