ADM-XRC SDK 2.8.1 User Guide (Linux)
© Copyright 2001-2009 Alpha Data
Prototype
ADMXRC_STATUS ADMXRC_StatusToString( ADMXRC_STATUS Status, char* Buffer, unsigned long Max);
Arguments
Argument | Type | Purpose |
Status | In | Error code |
Buffer | In | Buffer to receive textual description |
Max | In | The size of Buffer in bytes |
Return value
Value | Meaning |
ADMXRC_SUCCESS | A description of the error was successfully returned |
ADMXRC_NULL_POINTER | Buffer was NULL |
ADMXRC_INVALID_PARAMETER | Status was not a valid error code |
Description
This function returns in a textual description of an error in Buffer. At most Max characters, including the NULL terminator, are written to Buffer.