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.
- NNNN <= 00ff : common Error Codes shared among all ASP components
- NNNN > 00ff : component specific Error Codes
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
Common Error Codes
Alarm Error Codes
Availability Management Service Error Codes
Clovis Object Repository Error Codes
Component Manager Error Codes
Database Abstraction Layer Error Codes
Debug Service Error Codes
Event Service Error Codes
Execution Object Error Codes
Fault Manager Error Codes
Group Membership Service Error Codes
Intelligent Object Communication Error Codes
Log Service Error Codes
Mediation Library Error Codes
Name Service Error Codes
Provisioning Library Error Codes
Operating System Abstraction Layer Error Codes
Timer Error Codes
Transaction Error Codes
Performance Management Error Codes