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

215 lines
5.7 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>Signal a Condition (CEESGL) 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>Signal a Condition (CEESGL) API</h2>
<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;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%">cond_rep</td>
<td align="left" valign="top" width="30%">I/O</td>
<td align="left" valign="top" width="30%">FEEDBACK</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Omissible Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">2</td>
<td align="left" valign="top" width="30%">q_data_token</td>
<td align="left" valign="top" width="30%">Input</td>
<td align="left" valign="top" width="30%">INT4</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>
&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 Signal a Condition (CEESGL) API signals or resignals a condition to the
ILE condition manager.</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>Required Parameter</h3>
<dl>
<dt><strong>cond_rep (I/O)</strong></dt>
<dd>A condition token defining the condition to be raised.
<p>The CEESGL API always uses the facility_ID to retrieve a message, whether or
not instance specific information (ISI) is provided. If ISI is provided, the
message data from the message is used as insert data for the condition that is
to be raised.</p>
</dd>
</dl>
<h3>Omissible Parameter Group</h3>
<dl>
<dt><strong>q_data_token (input)</strong></dt>
<dd>A 32-bit data object to be placed in the ISI field for use in accessing the
qualifying data associated with the given instance of the condition. This
parameter is provided for compatibility purposes only. It is ignored on the
system.<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">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">CEE0201</td>
<td align="left" valign="top">The condition sent by &amp;1 was not handled</td>
</tr>
<tr>
<td align="left" valign="top">Severity: 00</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">CEE0258</td>
<td align="left" valign="top">The condition token passed to &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 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>
<p>If the condition is unhandled and a feedback code is provided, a message
number is returned in the fc parameter. The message number returned is
dependent on the severity of the condition when it reaches the control
boundary.</p>
<dl>
<dd>
<p>If the severity of the condition is 0-1, message number CEE0000 is returned.
The message is classified as a *STATUS message.</p>
</dd>
<dd>
<p>If the severity of the condition is 2-4, message number CEE0201 is returned.
The message is classified as an *ESCAPE message.</p>
</dd>
</dl>
<p>See <a href="ile3a1TOC.htm#TBLCHMAP1">Mapping i5/OS *ESCAPE Message
Severities to ILE Condition Severities</a> and <a href=
"ile3a1TOC.htm#TBLCHMAP2">Mapping i5/OS *STATUS and *NOTIFY Message Severities
to ILE Condition Severities</a> for the relationship of condition severities
and message severities.</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>