Error code parameter

An API error code parameter is a variable-length structure that is common to all of the system APIs.

The error code parameter controls how errors are returned to the application. The parameter must be initialized before the program calls the API. Depending on how the error code structure is set, this parameter either returns information associated with an error condition or causes errors to be returned as exception messages.

For some APIs, the error code parameter is optional. If you do not code the optional error code parameter, the API returns diagnostic and escape messages. If you code the optional error code parameter, the API can either signal exceptions or return the exception information in the error code parameter.

Notes:

The ILE CEE APIs use feedback codes and conditions.
The UNIX^®-type APIs and the National Language Data Conversion APIs use errno to report error conditions.

The error code structure is provided in the QSYSINC library and is called QUSEC.

Error code parameter format
Most iSeries™ APIs include an error code parameter to return error codes and exception data to the application. The error code parameter can be one of two variable-length structures, format ERRC0100 or format ERRC0200.
Examples: Receiving error conditions
These examples illustrate receiving error conditions
Using the job log to diagnose API errors
Sometimes an API may issue one or more messages that state that the API failed, and the messages may direct you to see the previously listed messages in the job log. If your application program needs to determine the cause of the error message, you can use the Receive Message (RCVMSG) command or the Receive Message APIs to receive the messages that explain the reason for the error.

Parent topic: API parameters

Related concepts

Include files and the QSYSINC library

Related reference

i5/OS Messages and the ILE CEE API Feedback Code