Use a return code in conjunction with its corresponding file status or reason code to determine the result of a call to the API, and identify the cause of a problem or failure if one arises.
| Return code | Description |
|---|---|
| 00 | Success - for a Get Next or Get Previous function call there was no key change from the previous call. |
| 01 | A Get Next or Get Previous function call resulted in retrieving a record with a different DD number from the previous call. |
| 02 | A Get Next or Get Previous function call resulted in retrieving a record with a different Job Step or JCL Procedure Step sequence number from the previous call. |
| 03 | A Get Next or Get Previous function call resulted in retrieving a record with a different job number from the previous call. |
| 04 | Warning. May be accompanied with a Reason Code of 10, signalling End of File. |
| 08 | Record not found for a Get Unique function call. |
| 12 | Error - includes file I/O errors other than open or start - file status will be set in the interface. |
| 16 | Severe error - includes file open and start failures, and spool file location errors. |
| 20 | Fatal error - includes invalid function or invalid key. |