Required Parameter:
1
| procedure
| Input
| RTX_ENTRY
|
Omissible Parameter:
2
| token
| Input
| POINTER
|
3
| fc
| Output
| FEEDBACK
|
Threadsafe: Yes
|
The Register Call Stack Entry Termination User Exit Procedure
(CEERTX) API registers
a user-defined procedure that runs when the call stack entry
for which it is registered is ended by anything other than a
return to the caller.
- procedure (input)
- An entry variable or constant for the procedure that is called
if the call stack entry is abnormally ended.
- token (input)
- A pointer that is passed to procedure.
If token is omitted, a null pointer is passed to
procedure when procedure is called.
- fc (output)
- A 12-byte feedback code.
CEE0000
Severity: 00
| The API completed successfully
|
CEE0256
Severity: 10
| Procedure already registered, registered again
|
CEE0257
Severity: 30
| The procedure provided for &1 is not valid
|
CEE3103
Severity: 30
| Cannot allocate storage in &1
|
CEE9902
Severity: 30
| Unexpected user error occurred in &1
|
- Multiple user call stack entry termination user exit
procedures can be
registered for each call stack entry.
- Call stack entry termination user exit
procedures run in first in/first out (FIFO) order.
If a procedure causes any of the following, the remaining procedures are
not run:
- The call to a call stack entry termination user exit
procedure fails.
- An exception is not handled.
- Control has moved past the invocation of the call stack entry
termination user exit procedure.
For example, the resume cursor has been moved, or
an out-of-scope jump, such as longjmp() in ILE C, has
been used.
- The message CEE0257 occurs only if the pointer contained in
the procedure parameter is not a procedure pointer.
This does not verify that
a call through that pointer will be successful.
For example, the call may fail because the activation group containing
the procedure no longer exists.
The following is the interface to the call stack entry
termination user exit procedure registered by the CEERTX API.
The procedure is coded as termination_procedure with the
following parameter.
- token (input)
- The user-supplied pointer passed on the call to CEERTX
that registered the call stack entry termination user exit procedure.