Set Program Return Code (CEE4SETRC) API

Required Parameter Group:

Input

INT4

Omissible Parameter:

Output

FEEDBACK

  Service Program Name: QLEAWI

  Default Public Authority: *USE

  Threadsafe: Yes

The Set Program Return Code (CEE4SETRC) API sets the program return code. The program return code is primarily used by the ILE C and ILE C++ languages to provide program status information to the caller of the program. The CEE4SETRC API allows other ILE languages to set the program return code value.

Authorities and Locks

None.

Required Parameter Group

rc (input): The new value for the program return code.

Omissible Parameter

fc (output): A 12-byte feedback code.

Feedback Codes and Conditions

CEE0000	The API completed successfully
Severity: 00

Usage Notes

The program return code is primarily used by the ILE C and ILE C++ languages. Other ILE languages do not usually use the program return code value, but these languages can use the return code value by using the CEE4GETRC and CEE4SETRC APIs.
Some ILE C and ILE C++ programs do not make use of the program return code. Consult the documentation for a program to see how it makes use of the program return code.
Exit point programs and database trigger programs can change the program return code after a program has returned, but before the return code value is retrieved by the caller. Be aware of this fact when making use of the program return code value.

API introduced: IBM^® i 7.1

[ Back to top | ILE CEE APIs | APIs by category ]