OpenClovis Logo

OpenClovis Error and Return 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 returned by OpenClovis APIs is 0xCCNNNN (given in hex), where 0xCC is the ASP Component Identifier and 0xNNNN is the Error Code.

The following macros, defined in clCommonErrors.h, help decoding the return codes:

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 tables are provided to help software engineers to quickly decode return codes found in ASP log files:

ASP Component Identifiers

ValueIdentifierComponent

Common Error Codes

ValueError CodeComments

Alarm Error Codes

ValueError CodeComments

Availability Management Service Error Codes

ValueError CodeComments

Clovis Object Repository Error Codes

ValueError CodeComments

Component Manager Error Codes

ValueError CodeComments

Database Abstraction Layer Error Codes

ValueError CodeComments

Debug Service Error Codes

ValueError CodeComments

Event Service Error Codes

ValueError CodeComments

Execution Object Error Codes

ValueError CodeComments

Fault Manager Error Codes

ValueError CodeComments

Group Membership Service Error Codes

ValueError CodeComments

Intelligent Object Communication Error Codes

ValueError CodeComments

Log Service Error Codes

ValueError CodeComments

Mediation Library Error Codes

ValueError CodeComments

Name Service Error Codes

ValueError CodeComments

Provisioning Library Error Codes

ValueError CodeComments

Operating System Abstraction Layer Error Codes

ValueError CodeComments

Timer Error Codes

ValueError CodeComments

Transaction Error Codes

ValueError CodeComments

Performance Management Error Codes

ValueError CodeComments

Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen