friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/CEEMGET.htm

274 lines
7.2 KiB
HTML
Raw Blame History

<!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>Get a Message (CEEMGET) 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 -->
<!-- ILE6A SCRIPT A converted by B2H R4.1 (346) (CMS) by NLJONES at -->
<!-- RCHVMX on 25 Feb 1999 at 15:10:11 -->
<!--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>Get a Message (CEEMGET) API</h2>
<div class="box" style="width: 60%;">
<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="50%">cond_token</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">FEEDBACK</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">message_area</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">VSTRING</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">msg_ptr</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">INT4</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Omissible Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="left" valign="top" width="50%">fc</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">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 Get a Message (CEEMGET) API retrieves a message and stores it in a
buffer for manipulation or output by the caller.</p>
<p>The API retrieves a message and places it in the storage location referenced
by the message_area parameter.</p>
<p>The msg_ptr parameter has a value of zero on the initial call to the CEEMGET
API. If the message is too large to be contained in <em>message_area</em>, <em>
msg_ptr</em> is returned containing an index into the message. The index is
used in subsequent calls to CEEMGET to retrieve the remaining portion of the
message. When the entire message has been retrieved, <em>msg_ptr</em> is
returned containing a value of zero.</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>cond_token (input)</strong></dt>
<dd>A 12-byte condition token. See <a href="ile3a2.htm">Using Condition Management APIs</a>
for a description of the condition token.<br>
<br>
</dd>
<dt><strong>message_area (output by descriptor)</strong></dt>
<dd>A valid ILE string variable, passed by reference with a descriptor. The
CEEMGET API places the retrieved message into this string variable.<br>
<br>
</dd>
<dt><strong>msg_ptr (input/output)</strong></dt>
<dd>A 4-byte integer with a value of 0 on the initial call to CEEMGET to
retrieve a message. If the message is too large to be contained in the <em>
message_area</em>, <em>msg_ptr</em> will be returned containing an index into
the message. The index is used in subsequent calls to CEEMGET to retrieve the
remaining portion of the message. When the entire message has been retrieved,
<em>msg_ptr</em> is returned with a value of 0.</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">CEE0102</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">CEE0454</td>
<td align="left" valign="top">&amp;1 cannot find message &amp;3 in message file
&amp;2</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">CEE0455</td>
<td align="left" valign="top">The message returned is truncated</td>
</tr>
<tr>
<td align="left" valign="top">Severity: 10</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
<tr>
<td align="left" valign="top">CEE0458</td>
<td align="left" valign="top">&amp;1 cannot find message file &amp;2</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">CEE0501</td>
<td align="left" valign="top">The operational descriptor data type 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">CEE0502</td>
<td align="left" valign="top">Missing operational descriptor</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">CEE3103</td>
<td align="left" valign="top">Cannot allocate storage in &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">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 <em>msg_ptr</em> is greater than the length of the message being
retrieved, then <em>msg_ptr</em> is set to 0, and a zero-length string is
copied into <em>message_area</em>.</p>
</li>
<li>
<p>Insert data cannot be inserted with this call.</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>
Reference in New Issue View Git Blame Copy Permalink