ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/CEE4ABN.htm

181 lines
5.5 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>Abnormal End (CEE4ABN) 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>Abnormal End (CEE4ABN) API</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Omissible Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">raise_TI</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">INT4</td>
</tr>
<tr>
<td align="center" valign="TOP">2</td>
<td align="LEFT" valign="TOP">cel_rc_mod</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">INT4</td>
</tr>
<tr>
<td align="center" valign="TOP">3</td>
<td align="LEFT" valign="TOP">user_rc</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">INT4</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program Name: QLEAWI<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>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.</p>
<br>
<!-- 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>Omissible Parameter Group</h3>
<dl>
<dt><strong>raise_TI (input)</strong></dt>
<dd>Whether or not the terminate-imminent condition should be raised before the
end operation.
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The terminate-imminent condition is not raised;
the abnormal end operation starts immediately. This value is the default if
<em>raise_TI</em> is omitted.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">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.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>cel_rc_mod (input)</strong></dt>
<dd>A language-specific return code passed from one ILE language to another ILE
language. The value and meaning is language-specific.<br>
<br>
</dd>
<dt><strong>user_rc (input)</strong></dt>
<dd>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.</dd>
</dl>
<br>
<h3>Conditions</h3>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="LEFT" valign="TOP">CEE9902</td>
<td align="LEFT" valign="TOP">Unexpected user error occurred in &amp;1</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">Severity: 30</td>
<td align="LEFT" valign="TOP">&nbsp;</td>
</tr>
</table>
<br>
<h3>Usage Notes</h3>
<ul>
<li>High-level language statements that implement abnormal ending of the
activation group do so by calling the CEE4ABN API.</li>
<li>The job-level return codes are updated whether or not the activation group
ended, provided that call stack entries were canceled.</li>
<li>This API cannot end the default activation group.</li>
</ul>
<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>