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

277 lines
7.1 KiB
HTML
Raw 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>Construct a Condition Token (CEENCOD) 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>Construct a Condition Token (CEENCOD) API</h2>
<div class="box" style="width: 70%;">
<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%">c_1</td>
<td align="left" valign="top" width="30%">Input</td>
<td align="left" valign="top" width="30%">INT2</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">c_2</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">INT2</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">case</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">INT2</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">severity</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">INT2</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">control</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">INT2</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">facility_id</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR3</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">i_s_info</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">INT4</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">cond_token</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">FEEDBACK</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Omissible Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">9</td>
<td align="left" valign="top" width="30%">fc</td>
<td align="left" valign="top" width="30%">Output</td>
<td align="left" valign="top" width="30%">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 Construct a Condition Token (CEENCOD) API is used to dynamically
construct a 12-byte condition token.</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><a name="SPTC1"><strong>c-1 (input)</strong></a></dt>
<dd>A 2-byte binary integer representing the value of the first part of the
Condition_ID. See <a href="ile3a1TOC.htm#SPTMSGSEV">MsgSev</a>.<br>
<br>
</dd>
<dt><strong>c-2 (input)</strong></dt>
<dd>A 2-byte binary integer representing of the value of the second part of the
Condition_ID. See the description of <a href="ile3a1TOC.htm#SPTMSGNO">
MsgNo</a>.<br>
<br>
</dd>
<dt><strong>case (input)</strong></dt>
<dd>A 2-byte binary integer that defines the format of the Condition_ID portion
of the token. See the description of <a href="ile3a1TOC.htm#SPTCASE">
Case</a>.<br>
<br>
</dd>
<dt><strong>severity (input)</strong></dt>
<dd>A 2-byte unsigned binary integer that indicates the condition's severity.
The value of this field is the same as in <a href="#SPTC1">C-1</a>.<br>
<br>
</dd>
<dt><strong>control (input)</strong></dt>
<dd>A 2-byte binary number containing the control information of the condition.
See the description of <a href="ile3a1TOC.htm#SPTCONTROL">Control</a>.<br>
<br>
</dd>
<dt><strong>facility_id (input)</strong></dt>
<dd>A 3-character field containing three alphanumeric characters that identify
the product generating this condition or feedback information. See the
description of <a href="ile3a1TOC.htm#SPTFAC">Facility-ID</a>.<br>
<br>
</dd>
<dt><strong>i_s_info (input)</strong></dt>
<dd>A 4-byte handle identifying the instance specific information. See the
description of <a href="ile3a1TOC.htm#SPTISI">I-95 S-Info</a>.<br>
<br>
</dd>
<dt><strong>cond_token (output)</strong></dt>
<dd>The 12-byte representation of the constructed condition or feedback
information. See <a href="ile3a1TOC.htm#ile3a2">How Conditions Are
Represented</a>.</dd>
</dl>
<br>
<h3>Omissible Parameter</h3>
<dl>
<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">CEE0401</td>
<td align="left" valign="top">The Case parameter 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 align="left" valign="top">CEE0402</td>
<td align="left" valign="top">Unsupported control code &amp;2 passed to
procedure &amp;1</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">CEE0403</td>
<td align="left" valign="top">Severity 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>
</table>
<br>
<h3>Usage Notes</h3>
<ul>
<li>
<p>If the severity in C_1 does not match the severity in the Severity
parameter, message CEE0403 is raised.</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>