Error Handling API
This section describes the following error-handling functions:
Function | Description |
---|---|
VLSerrorHandle | Toggles default error handling ON or OFF. |
LSGetMessage | Prints licensing library-defined error messages corresponding to specified error code. |
VLSsetErrorHandler | Registers custom error handlers. |
VLSsetUserErrorFile | Configures the display of error messages. |
The Sentinel RMS licensing library has a built-in error handler for each type of error listed. An error handler is a simple function that tries to correct whatever situation caused the error condition to occur.
In most cases, the conditions are difficult to correct, and the handlers perform some clean-up tasks and display error messages. If an error occurs while processing a function call and the default error handlers are unable to correct the situation, the API functions return an error code after displaying an appropriate error message. If the built-in error handlers are able to correct the error-causing condition, the function call returns the success code, LS_SUCCESS, as if the error never occurred.
Given below is the list of the API functions: