VLScgGetErrorMessage

Syntax

int VLScgGetErrorMessage(VLScg_HANDLE iHandle, char *msgBuf, int bufLen);
Argument Description
iHandle

The instance handle for this library.

msgBuf

A user allocated buffer into which the reference message will be copied.

bufLen

The byte length of the message copied into msgBuf.

Description

Retrieves the oldest error queued to the handle, and copies a maximum of bufLen bytes to msgBuf as a null-terminated string. msgBuf is a user-allocated buffer and must be bufLen bytes in length. Upon successful completion of this function, the message retrieved is removed from queue.

Returns

The status code VLScg_SUCCESS is returned, if successful. Otherwise, it returns the following error codes:

Error Code Description

VLScg_FAIL

If operation failed.

For the complete list of the error codes, refer to License Generation and Revocation Error Codes .