acedRetStr

C++

int acedRetStr(
    const ACHAR * s
);

File

acedads.h

Description

Returns a string to AutoLISP. The AutoLISP expression that invoked the external function returns the string result, as built-in and user-defined AutoLISP functions do.

The acedRetStr() function passes the entire string, not its address. If s is too long, it is truncated. The maximum allowable length is 503 characters (with the 504th character reserved for the null character, EOS).

An external function can make more than one call to value-return functions upon a single kInvkSubrMsg message, but the AutoLISP function returns only the value passed it by the last value-return function invoked.

If acedRetStr() succeeds, it returns RTNORM; it returns RTERROR if it fails or if s is a null pointer.

Parameters