Abnormal End (CEE4ABN) API

Omissible Parameter Group:

1	raise_TI	Input	INT4
2	cel_rc_mod	Input	INT4
3	user_rc	Input	INT4

  Service Program Name: QLEAWI

  Default Public Authority: *USE

  Threadsafe: Yes

The Abnormal End (CEE4ABN) API abnormally ends the activation group containing the nearest control boundary. The termination-imminent condition can be sent first to give all intervening call stack entries a chance to clean up or stop the abnormal end. This is optional. All call stack entries to the nearest control boundary are ended, 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. The exception message CEE9901 (application error) is sent to the caller of the control boundary, whether or not the activation group ended, provided that call stack entries were ended.

Authorities and Locks

None.

Omissible Parameter Group

raise_TI (input)

Whether or not the terminate-imminent condition should be raised before the end operation.

0	The terminate-imminent condition is not raised; the abnormal end operation starts immediately. This value is the default if raise_TI is omitted.
1	The terminate-imminent condition is raised. The abnormal end operation occurs only if the handling of the terminate-imminent condition results in the resume cursor not being moved after a resume operation was requested, or, the terminate-imminent condition is not handled.

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 CEE4ABN 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

High-level language statements that implement abnormal ending of the activation group do so by calling the CEE4ABN API.
The job-level return codes are updated whether or not the activation group ended, provided that 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 ]