Error/Return Codes

Common and Component specific Error Codes. More...

Common and Component specific Error Codes.

The majority of ASP API functions return a Return Code as their return value. A zero return code (CL_OK) always indicates success. Non-zero return codes always carry two types of information, masked into one single value: a Component Identifier and an Error Code. The component identifier identifies the component (or software layer) in which the problem occurred, while the error code describes the nature of the problem. Some error codes are common across all components, while others are component specific.

The format of the Return Codes is 0xCCNNNN (given in hex), where 0xCC is the ASP Component Identifier and 0xNNNN is the Error Code.

Note

Only the Error Codes are listed as Return values in the Function Documentation of the API Reference pages. The real return value also contains the Component Identifier!

The following links are useful while interpreting Buffer Manager generated return codes:

• Buffer Manager Component Identifier
• Common Error Codes

For further details and information about all error/return codes visit page OpenClovis Error and Return Codes.