ADM-XRC SDK 2.8.1 User Guide (Linux)
© Copyright 2001-2009 Alpha Data


ADMXRC2_StatusToString

Prototype

ADMXRC2_STATUS
ADMXRC2_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
ADMXRC2_SUCCESS A description of the error was successfully returned
ADMXRC2_NULL_POINTER Buffer was NULL
ADMXRC2_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.

 


 Top of page