ADM-XRC SDK 2.8.1 User Guide (Linux)
© Copyright 2001-2009 Alpha Data
Prototype
const char* ADMXRC2_GetStatusString( ADMXRC2_STATUS Code);
Arguments
Argument | Type | Purpose |
Code | In | The error code to convert to a string |
Return value
Unlike most API functions, ADMXRC2_GetStatusString returns a pointer to a NULL terminated string that describes the error code.
Description
This function returns a textual description of the error code passed in the Code parameter. The returned string should be treated as read-only since it is statically allocated. If the Code parameter contains a code that is not one of the members of the enumerated type ADMXRC2_STATUS, the string returned will be
"unknown ADMXRC2_STATUS code"