acedGetCName

C++

inline int acedGetCName(
    const ACHAR * cmd, 
    ACHAR ** result
);

File

acedads.h

Description

Deprecated. Gets the localized or the language independent name of a command.

I.e., translates a command name from local to global, or from global to local.

The acedGetCName() function returns RTNORM to indicate success, RTERROR to indicate failure to allocate memory for the string result, or another error code if the function fails to retrieve the result.

Parameters

Parameters	Description
cmd	Input string which is the command name (maximum 64 characters) to be translated.If the first char is underbar ('_'), then `cmd` is taken as global (language independent), and the function returns the localized name.Otherwise, `cmd` is take as localized and the global name is returned.
result	Output pointer to an out pointer which receives the address of the buffer containing the translated name. The caller is responsible for freeing up this buffer.On error, *result will be set to `nullptr`.

Returns

Returns RTNORM on success, else RTERROR.

Pointer to the string result, which for the French command ETIRER would be STRETCH.

Remarks

This overload returning an allocated buffer is deprecated and may be removed.

It is recommended to use the AcString-based overload instead.

The AcString-based overload returns an empty string on error.

Use Instead

ACCORE_PORT int acedGetCName(const ACHAR * cmd, AcString & sOut);