DLM API Error Codes
General
DLM API functions use a unified set of error codes defined in
dlmdef.h. All error codes have negative values.
If unsuccessful, most API functions return a negative error code indicating
the reason for the failure. The auxiliary function, dlm_ErrorMessage(),
translates error return codes into human-readable strings.
As negative return values indicate failure, non-negative return values indicate success.
A few DLM API functions return values other than the negative error codes for failure
or the non-negative values for success. For instance, the functions
dlm_MonState() and
dlm_TapState()
return the current state as defined in dlmdef.h.
Alphabetical Listing of Error Codes
- dlm_ERROR_AUTHENTICATION_FAILURE
- The monitor authentication failed.
- dlm_ERROR_CONNECTION_FAILURE
- There was a failure on the established connection.
- dlm_ERROR_CONNECTION_INCOMPLETE
- The attempted connection has not completed.
- dlm_ERROR_END_OF_FILE
- The file's normal end of file was found.
- dlm_ERROR_FAILURE_CONNECTING
- The connection attempt failed.
- dlm_ERROR_FAILURE_INITIALIZING
- The module failed to initialize.
- dlm_ERROR_FAILURE_OPENING_FILE
- A failure occurred when trying to open the file.
- dlm_ERROR_FAILURE_READING_FILE
- A failure occurred when trying to read from the file.
- dlm_ERROR_FAILURE_WRITING_FILE
- A failure occurred when trying to write to the file.
- dlm_ERROR_FILE_NOT_FOUND
- The file could not be found.
- dlm_ERROR_INVALID_COMMAND
- The DLM command is not valid for the state of the API.
- dlm_ERROR_INVALID_FILE
- The file was invalid.
- dlm_ERROR_INVALID_ID
- The id value was NULL.
- dlm_ERROR_INVALID_LINE_ID
- The line id is greater than the number of valid sessions.
- dlm_ERROR_INVALID_PARAMETERS
- The parameters input are invalid for the function requested.
- dlm_ERROR_INVALID_PASSWORD
- The monitor authentication failed due to an invalid password.
- dlm_ERROR_OUT_OF_MEMORY
- The requested operation cannot be performed because the memory
could not be allocated.
- dlm_ERROR_PROTOCOL_FAILURE
- The module is not in the proper state to perform the desired event or
the protocol version is incorrect.