277 lines
7.2 KiB
HTML
277 lines
7.2 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Register Call Stack Entry Termination User Exit Procedure (CEERTX)
|
|
API</title>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- ILE2A SCRIPT A converted by B2H R4.1 (346) (CMS) by NLJONES at -->
|
|
<!-- RCHVMX on 25 Feb 1999 at 10:45:20 -->
|
|
<!--Edited by Kersten Oct 2001 -->
|
|
<!-- End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<!-- Java sync-link -->
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<a name="Top_Of_Page"></a>
|
|
|
|
<h2>Register Call Stack Entry Termination User Exit Procedure (CEERTX) API</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
<br>
|
|
Required Parameter:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="30%">procedure</td>
|
|
<td align="left" valign="top" width="30%">Input</td>
|
|
<td align="left" valign="top" width="30%">RTX_ENTRY</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Omissible Parameter:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">2</td>
|
|
<td align="left" valign="top" width="30%">token</td>
|
|
<td align="left" valign="top" width="30%">Input</td>
|
|
<td align="left" valign="top" width="30%">POINTER</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">fc</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">FEEDBACK</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Service Program Name: QLEAWI<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>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.</p>
|
|
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
|
|
<h3>Required Parameter</h3>
|
|
|
|
<dl>
|
|
<dt><strong>procedure (input)</strong></dt>
|
|
|
|
<dd>An entry variable or constant for the procedure that is called if the call
|
|
stack entry is abnormally ended.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Omissible Parameter</h3>
|
|
|
|
<dl>
|
|
<dt><strong>token (input)</strong></dt>
|
|
|
|
<dd>A pointer that is passed to <em>procedure</em>. If <em>token</em> is
|
|
omitted, a null pointer is passed to <em>procedure</em> when <em>procedure</em>
|
|
is called.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>fc (output)</strong></dt>
|
|
|
|
<dd>A 12-byte feedback code.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Feedback Codes and Conditions</h3>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top">CEE0000</td>
|
|
<td align="left" valign="top">The API completed successfully</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Severity: 00</td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CEE0256</td>
|
|
<td align="left" valign="top">Procedure already registered, registered
|
|
again</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Severity: 10</td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CEE0257</td>
|
|
<td align="left" valign="top">The procedure provided for &1 is not
|
|
valid</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Severity: 30</td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CEE3103</td>
|
|
<td align="left" valign="top">Cannot allocate storage in &1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Severity: 30</td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CEE9902</td>
|
|
<td align="left" valign="top">Unexpected user error occurred in &1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Severity: 30</td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<h3>Usage Notes</h3>
|
|
|
|
<ul>
|
|
<li>
|
|
<p>Multiple user call stack entry termination user exit procedures can be
|
|
registered for each call stack entry.</p>
|
|
</li>
|
|
|
|
<li>
|
|
<p>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:</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<p>The call to a call stack entry termination user exit procedure fails.</p>
|
|
</li>
|
|
|
|
<li>
|
|
<p>An exception is not handled.</p>
|
|
</li>
|
|
|
|
<li>
|
|
<p>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 <em>longjmp()</em> in ILE C, has been used.</p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>
|
|
<p>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.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<br>
|
|
<h3>Interface to the Call Stack Entry Termination User Exit Procedure</h3>
|
|
|
|
<p>The following is the interface to the call stack entry termination user exit
|
|
procedure registered by the CEERTX API. The procedure is coded as <strong>
|
|
termination_procedure</strong> with the following parameter.</p>
|
|
|
|
<br>
|
|
<div class="box" style="width: 60%;">
|
|
<br>
|
|
Required Parameter:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="30%">token</td>
|
|
<td align="left" valign="top" width="30">Input</td>
|
|
<td align="left" valign="top" width="30%">POINTER</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</div>
|
|
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
|
|
<h3>Required Parameter</h3>
|
|
|
|
<dl>
|
|
<dt><strong>token (input)</strong></dt>
|
|
|
|
<dd>The user-supplied pointer passed on the call to CEERTX that registered the
|
|
call stack entry termination user exit procedure.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V2R3
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"ile1a1.htm">ILE CEE APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|