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

259 lines
6.3 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!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>Handle a Condition (CEE4HC) 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 -->
<!-- ILE3A SCRIPT A converted by B2H R4.1 (346) (CMS) by NLJONES at -->
<!-- RCHVMX on 8 Mar 1999 at 11:01:18 -->
<!-- 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>Handle a Condition (CEE4HC) API</h2>
<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;Required 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="30%">isi</td>
<td align="LEFT" valign="TOP" width="30%">Input</td>
<td align="LEFT" valign="TOP" width="30%">UINT4</td>
</tr>
<tr>
<td align="center" valign="TOP">2<br>
</td>
<td align="LEFT" valign="TOP">inv</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">INVPTR</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Omissible Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="TOP" width="10%">3</td>
<td align="LEFT" valign="TOP" width="30%">option</td>
<td align="LEFT" valign="TOP" width="30%">Input</td>
<td align="LEFT" valign="TOP" width="30%">UINT4</td>
</tr>
<tr>
<td align="center" valign="TOP">4</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>
&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 Handle a Condition (CEE4HC) API handles a specified condition and,
optionally, logs the condition.</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 Group</h3>
<dl>
<dt><strong>isi (input)</strong></dt>
<dd>The instance specific information number for the condition. This is the
message reference key of the underlying server exception.<br>
<br>
</dd>
<dt><strong>inv (input)</strong></dt>
<dd>The call stack entry that the handle cursor points to for the condition.
This is the target call stack entry of the underlying server exception.<br>
<br>
</dd>
</dl>
<br>
<h3>Omissible Parameter Group</h3>
<dl>
<dt><strong>option (input)</strong></dt>
<dd>The options are:<br>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Take the default log action for the message.
*ESCAPE and function check messages are logged. *STATUS messages are never
logged.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Do not log the condition.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Log the condition. Only conditions with a
severity greater than 1 can be logged.</td>
</tr>
</table>
<p>If the option parameter is omitted, the value 0 is used.</p>
</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">&nbsp;</td>
</tr>
<tr>
<td>CEE3104</td>
<td align="LEFT" valign="TOP">The pointer type in &amp;1 is not valid</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">Severity: 30</td>
<td align="LEFT" valign="TOP">&nbsp;</td>
</tr>
<tr>
<td>CEE3105</td>
<td align="LEFT" valign="TOP">The call stack entry given to &amp;1 no longer
exists</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">Severity: 30</td>
<td align="LEFT" valign="TOP">&nbsp;</td>
</tr>
<tr>
<td>CEE3107</td>
<td align="LEFT" valign="TOP">The message specified for &amp;1 is not an
exception message</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">Severity: 30</td>
<td align="LEFT" valign="TOP">&nbsp;</td>
</tr>
<tr>
<td>CEE3108</td>
<td align="LEFT" valign="TOP">The option specified for &amp;1 is not valid</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">Severity: 30</td>
<td align="LEFT" valign="TOP">&nbsp;</td>
</tr>
<tr>
<td>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>
<br>
<h3>Usage Notes</h3>
<ul>
<li>
<p>The call stack entry that <em>inv</em> points to must appear in the call
stack for the job issuing the call to the CEE4HC API.</p>
</li>
<li>
<p>The CEE4HC API can be used to take a previously handled message out of the
job log, but only if that message is enqueued on <em>inv</em>.</p>
</li>
<li>
<p>The CEE4HC API can be used to handle *ESCAPE, *STATUS, *NOTIFY, and function
check exceptions. A default reply is sent for *NOTIFY messages if no reply has
been sent previously.</p>
</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>