Normal End (CEETREC) API

Omissible Parameter Group:

1	cel_rc_mod	Input	INT4
2	user_rc	Input	INT4

  Service Program Name: QLEAWI

  Default Public Authority: *USE

  Threadsafe: Yes

The Normal End (CEETREC) API is used to do a normal ending of the activation group containing the nearest control boundary. First, the terminate-imminent condition is sent to give all intervening call stack entries a chance to clean up, or stop the end operation. All call stack entries to the nearest control boundary end unless the resume cursor is moved while handling the terminate-imminent condition. If the call stack entry for the control boundary is also the oldest call stack entry in the activation group, the activation group ends, provided that call stack entries were ended.

Authorities and Locks

None.

Omissible Parameter Group

cel_rc_mod (input): A language-specific return code passed from one ILE language to another ILE language. The value and meaning is language-specific.
user_rc (input): A number representing the user portion of the activation group return code. If this parameter is not supplied, the CEETREC API uses the current contents of the activation group return code. If it is supplied, it takes precedence over previously set values.

Conditions

CEE9902	Unexpected user error occurred in &1
Severity: 30

Usage Notes

A normal end operation by high-level language exit statements is implemented by calling the CEETREC API. The termination-imminent condition is sent to the control boundary.
The activation group and job-level return codes are updated whether or not the activation group ended, provided call stack entries were canceled.
This API cannot end the default activation group.

API introduced: V2R3

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