API return code format

This section explains the API (Application Programming Interface) return code format. For each return code, the following information is provided:

The return code number. This number corresponds to the number in the dsmrc.h header file.

The severity code. This letter is an indication of the severity that generated the return code. The possible severity codes and their meanings include:

S	Severe error	Processing cannot continue.
E	Error	Processing cannot continue.
W	Warning	Processing can continue, but problems might develop later. You should be cautious.
I	Information	Processing continues. User response is not necessary.

The symbolic name. This name corresponds to the definition in the header file, dsmrc.h. Always use the symbolic name for a return code in your application rather than the return code number.
The explanation. This field explains the circumstances under which this return code might be generated.
The system action. This field describes what action Tivoli Storage Manager is going to take in response to the return code.
The user response. This field explains how you should respond to the system action.

Many of the return codes describe errors that cause processing to stop. You can send a message to the end user that describes the problem and suggest a course of action. To identify different messages, use these return code values or develop your own numbering system.