Interpreting Return Codes

Error Message

lgo_ErrorMessage()

Retrieve a human-readable string describing an error.

Syntax
#include "laygomsg.h"

LMessage lgo_ErrorMessage
    (
         LError    error
    );
errorerror code to retrieve error message for
Description

lgo_ErrorMessage() retrieves a human-readable string describing an error code returned by a LayGO API function.

Return Values

All calls to lgo_ErrorMessage() are successful. If the error code is not defined, the message "LayGO error code not defined" is returned.

Example
if ((bytes = lgo_Read(cid, buffer, size)) < 0)
{
    msgString = lgo_ErrorMessage(bytes);
    printf("lgo_Read() failure: '%s'\n", msgString);
}
else
{
    /* process data */
}