VLSucgGetErrorMessage

Syntax

int VLSucgGetErrorMessage ( VLSucg_HANDLE  iHandle, char *msgBuf, int bufLen );

Argument	Description
iHandle	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

Returns the earliest error from the handle up to bufLen characters.

>The bufLen must be the length of the pre allocated buffer msgBuf.

>The message returned should always be NULL terminated.

Returns

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

Error Code	Description
VLSucg_BAD_HANDLE	If the handle passed is not a valid handle.
VLSucg_FAIL	On failure.

For the complete list of the error codes, refer to Upgrade License Error Codes.