2550 lines
79 KiB
HTML
2550 lines
79 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>List Nonprogram Messages (QMHLSTM) 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. -->
|
|
<!-- MH1TEMP SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
|
|
<!-- RCHVMW2 on 26 Jan 1999 at 10:37:34 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File Edited Oct 2001 by v2cdijab -->
|
|
<!--End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<a name="Top_Of_Page"></a>
|
|
<!-- Java sync-link -->
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>List Nonprogram Messages (QMHLSTM) API</h2>
|
|
|
|
<div class="box" style="width: 70%;">
|
|
<br>
|
|
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="55%">Qualified user space name</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="15%">Char(20)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Format name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Message selection information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Size of message selection information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Format of message selection information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The List Nonprogram Messages (QMHLSTM) API lists messages from one or two
|
|
nonprogram message queues. This API obtains the requested message information
|
|
and returns it in a user space through the format specified in the parameter
|
|
list.</p>
|
|
|
|
<p>If multiple message queues are specified, the messages are sorted by their
|
|
sending dates and times. However, messages listed as a reply message to an
|
|
inquiry or a sender's copy message are sorted differently. When a reply message
|
|
exists for one of these types, it is listed immediately following the inquiry
|
|
or sender's copy message with which it is associated.</p>
|
|
|
|
<p>If messages in multiple queues have identical sending dates and times, the
|
|
message from the first queue in the qualified message queue names array is
|
|
listed first.</p>
|
|
|
|
<p>If the last message listed is an inquiry or sender's copy message, the user
|
|
must call the API again using parameters that would include listing the next
|
|
later message after the inquiry or sender's copy message in order to determine
|
|
and obtain an available reply message.</p>
|
|
|
|
<p>The QMHLSTM API lists messages from nonprogram message queues only. The
|
|
QMHLSTM API cannot be used to list messages sent to a job log (including the
|
|
external message (*EXT) queue of a job). See <a href="QMHLJOBL.htm">List Job
|
|
Log Messages</a> (QMHLJOBL) API for information on listing messages sent to a
|
|
job log. QMHLSTM cannot be used to list messages sent to the history log
|
|
(QHST).</p>
|
|
|
|
<p>The generated list replaces any existing information in the user space.</p>
|
|
|
|
<p>If the user space is not large enough to contain the amount of data that is
|
|
to be returned, the user space is increased up to the maximum user space size
|
|
allowed (16MB) or to the maximum amount of storage allowed to the user of the
|
|
API. If this is not large enough to contain the data to be returned, only the
|
|
number of complete messages that fit in the user space are returned. The
|
|
information status field in the generic header is set to P (partial but
|
|
accurate). The user can then resubmit the request from the last message
|
|
returned to obtain the additional messages. The key of the last message listed
|
|
for each message queue is provided in the ending message key field in the
|
|
header portion of the user space.</p>
|
|
|
|
<p>An alternative to making multiple calls to QMHLSTM to list all of the messages
|
|
is to change to use the Open List of Messages (QGYOLMSG) API. QGYOLMSG can
|
|
create a list that contains up to 2GB of data. Instead of acessing a user
|
|
space to get the message entries, the Get List Entry (QGYGTLE) API is
|
|
used to get the the message entries from the list created by QGYOLMSG.</p>
|
|
|
|
<p>New messages are prevented from being added to or removed from the message
|
|
queues being listed during the use of this API. The maximum messages requested
|
|
field and the number of fields to return field for each listed message
|
|
increases the time that the queues are unavailable. Users of this API should
|
|
use caution when listing many messages or many fields. Try to avoid causing
|
|
lock-out situations on highly used message queues.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Message queue</em></dt>
|
|
|
|
<dd>*USE</dd>
|
|
|
|
<dt><em>Message queue library</em></dt>
|
|
|
|
<dd>*EXECUTE</dd>
|
|
|
|
<dt><em>User space</em></dt>
|
|
|
|
<dd>*CHANGE</dd>
|
|
|
|
<dt><em>User space library</em></dt>
|
|
|
|
<dd>*EXECUTE</dd>
|
|
|
|
<dt><em>User space lock</em></dt>
|
|
|
|
<dd>*EXCLRD</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Qualified user space name</strong></dt>
|
|
|
|
<dd>INPUT;CHAR(20)
|
|
|
|
<p>The user space that receives the generated list, and the library in which it
|
|
is located. The first 10 characters contain the user space name, and the second
|
|
10 characters contain the user space library. You can use these special values
|
|
for the library name:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
|
<td align="left" valign="top">The job's current library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">The library list</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the returned message information. You must use this
|
|
format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>LSTM0100</em></td>
|
|
<td align="left" valign="top">Basic message information with identified return
|
|
fields. This format is described in <a href="#HDRLSTM01">LSTM0100
|
|
Format</a>.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Message selection information</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The information that determines the message queues and messages to be
|
|
listed. The format of this information is described in <a href="#HDRINFMT01">
|
|
MSLT0100 Format</a> and in <a href="#HDRINFMT03">MSLT0200 Format</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Size of message selection information</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The size, in bytes, of the message selection information parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format of message selection information</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the message selection information parameter. You must use one
|
|
of these formats:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>MSLT0100</em></td>
|
|
<td align="left" valign="top">The specific information identifying the messages
|
|
to be listed. This format is described in <a href="#HDRINFMT01">MSLT0100
|
|
Format</a>. Message text and data are returned in the CCSID of your job.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>MSLT0200</em></td>
|
|
<td align="left" valign="top">The specific information identifying the messages
|
|
to be listed. This format is described in <a href="#HDRINFMT03">MSLT0200
|
|
Format</a>. This is the same as format MSLT0100 with the exception of the
|
|
following:<br>
|
|
|
|
|
|
<ul>
|
|
<li>You are able to specify the CCSID in which you wish your message text and
|
|
data returned.</li>
|
|
|
|
<li>You may optionally specify a date and time with which to begin the list,
|
|
relative to the beginning message key.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Format of Generated Lists</h3>
|
|
|
|
<p>The user space created consists of:</p>
|
|
|
|
<ul>
|
|
<li>A user area</li>
|
|
|
|
<li>A generic header</li>
|
|
|
|
<li>An input parameter section</li>
|
|
|
|
<li>A header section</li>
|
|
|
|
<li>LSTM0100 format</li>
|
|
</ul>
|
|
|
|
<p>For details about the user area and generic header, see <a href="../apiref/usf.htm">
|
|
User Space Format for List APIs</a>. For details about the remaining items, see
|
|
the following sections. For descriptions of each field in the list returned,
|
|
see <a href="#HDRLSTFD">Field Descriptions</a>.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Input Parameter Section</h3>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">User space name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User space library specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Format name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Format of message selection information
|
|
specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Size of message selection information
|
|
specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum messages requested specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">List direction specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Selection criteria specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Severity criteria specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">68</td>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum message length specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">72</td>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum message help length specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">76</td>
|
|
<td align="center" valign="top">4C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to message queue names specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to starting message keys specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of message queues specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="center" valign="top">58</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to identifiers of fields to return
|
|
specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">92</td>
|
|
<td align="center" valign="top">5C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of fields to return specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">96</td>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Coded character set identifier (CCSID)
|
|
specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top">CHAR(13)</td>
|
|
<td align="left" valign="top">Date and time criteria specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">113</td>
|
|
<td align="center" valign="top">71</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" rowspan="3" colspan="2">The offsets to these
|
|
fields are specified in the previous offset variables.</td>
|
|
<td align="left" valign="top">ARRAY(*) of CHAR(20)</td>
|
|
<td align="left" valign="top">Message queue names specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">ARRAY(*) of CHAR(4)</td>
|
|
<td align="left" valign="top">Starting message key specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">ARRAY(*) of BINARY(4)</td>
|
|
<td align="left" valign="top">Identifiers of fields to return specified</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Header Section</h3>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">User space name used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User space library used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to message queue names used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to starting message keys used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to ending message keys</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of message queues used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Coded character set identifier (CCSID) used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(13)</td>
|
|
<td align="left" valign="top">Date and time of first message listed</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">53</td>
|
|
<td align="center" valign="top">35</td>
|
|
<td align="left" valign="top">CHAR(13)</td>
|
|
<td align="left" valign="top">Date and time of last message listed</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">66</td>
|
|
<td align="center" valign="top">42</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" rowspan="3" colspan="2">The offsets to these
|
|
fields are specified in the previous offset variables.</td>
|
|
<td align="left" valign="top">ARRAY(*) of CHAR(20)</td>
|
|
<td align="left" valign="top">Message queue names used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">ARRAY(*) of CHAR(4)</td>
|
|
<td align="left" valign="top">Starting message key used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">ARRAY(*) of CHAR(4)</td>
|
|
<td align="left" valign="top">Ending message key used</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRLSTM01">LSTM0100 Format</a></h3>
|
|
|
|
<p>The following table shows the information returned in the list data section
|
|
of the user space for the LSTM0100 format. The offsets listed are from the
|
|
beginning of the user space. For a detailed description of each field, see <a
|
|
href="#HDRLSTFD">Field Descriptions</a>.</p>
|
|
|
|
<p>The structure defined by this format is repeated for each message entry
|
|
returned.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Offset to the next entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to fields returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of fields returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Message severity</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
<td align="left" valign="top">Message identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">23</td>
|
|
<td align="center" valign="top">17</td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Message type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">25</td>
|
|
<td align="center" valign="top">19</td>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Message key</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">29</td>
|
|
<td align="center" valign="top">1D</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Message file name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">39</td>
|
|
<td align="center" valign="top">27</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Message file library specified at send time</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">49</td>
|
|
<td align="center" valign="top">31</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Message queue</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">59</td>
|
|
<td align="center" valign="top">3B</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Message queue library used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">69</td>
|
|
<td align="center" valign="top">45</td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
<td align="left" valign="top">Date sent</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">76</td>
|
|
<td align="center" valign="top">4C</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Time sent</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">82</td>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Microseconds</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="center" valign="top">58</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" rowspan="9" colspan="2">These fields repeat for
|
|
each identifier field specified.</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to the next field information
|
|
returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of field information returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Identifier field</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Type of data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Status of data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(14)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRINFMT01">MSLT0100 Format</a></h3>
|
|
|
|
<p>The organization of the MSLT0100 format of the message selection information
|
|
parameter follows. For a detailed description of each field, see <a href=
|
|
"#HDRLSTFD">Field Descriptions</a>.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Maximum messages requested</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">List direction</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="center" valign="top">E</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Selection criteria</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Severity criteria</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum message length</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum message help length</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to qualified message queue names</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to starting message keys</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of message queues</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to identifiers of fields to return</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="center" valign="top">34</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of fields to return</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" rowspan="3" colspan="2">The offsets to these
|
|
fields are specified in the previous offset variables.</td>
|
|
<td align="left" valign="top">ARRAY(*) of CHAR(20)</td>
|
|
<td align="left" valign="top">Qualified message queue names</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">ARRAY(*) of CHAR(4)</td>
|
|
<td align="left" valign="top">Starting message key</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">ARRAY(*) of BINARY(4)</td>
|
|
<td align="left" valign="top">Identifiers of fields to return</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRINFMT03">MSLT0200 Format</a></h3>
|
|
|
|
<p>The organization of the MSLT0200 format of the message selection information
|
|
parameter follows. For a detailed description of each field, see <a href=
|
|
"#HDRLSTFD">Field Descriptions</a>.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Maximum messages requested</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">List direction</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="center" valign="top">E</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Selection criteria</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Severity criteria</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum message length</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum message help length</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to qualified message queue names</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to starting message keys</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of message queues</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to identifiers of fields to return</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="center" valign="top">34</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of fields to return</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">56</td>
|
|
<td align="center" valign="top">38</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Coded character set identifier (CCSID) to return
|
|
text and data in</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="center" valign="top">3C</td>
|
|
<td align="left" valign="top">CHAR(13)</td>
|
|
<td align="left" valign="top">Date and time criteria</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">73</td>
|
|
<td align="center" valign="top">49</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Reserved (Must be blanks)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">76</td>
|
|
<td align="center" valign="top">4C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Reserved (Must be 0)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" rowspan="4" colspan="2">The offsets to these
|
|
fields are specified in the previous offset variables.</td>
|
|
<td align="left" valign="top">ARRAY(*) of CHAR(20)</td>
|
|
<td align="left" valign="top">Qualified message queue names</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">ARRAY(*) of CHAR(4)</td>
|
|
<td align="left" valign="top">Starting message key</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">ARRAY(*) of BINARY(4)</td>
|
|
<td align="left" valign="top">Identifiers of fields to return</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRLIDS">Valid Field Identifiers</a></h3>
|
|
|
|
<p>The following table contains a list of the valid identifiers for the
|
|
MSLT0100 and the MSLT0200 format.</p>
|
|
|
|
<table border width="90%">
|
|
<tr>
|
|
<th align="left" valign="top">Identifier</th>
|
|
<th align="left" valign="top">Type</th>
|
|
<th align="left" valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">0101</td>
|
|
<td align="left" valign="top" width="20%">CHAR(9)</td>
|
|
<td align="left" valign="top" width="65%">Alert option</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0201</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Replacement data or impromptu message text</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0301</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Message</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0302</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Message with replacement data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0401</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Message help</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0402</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Message help with replacement data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0403</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Message help with formatting characters</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0404</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Message help with replacement data and formatting
|
|
characters</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0501</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Default reply</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0601</td>
|
|
<td align="left" valign="top">CHAR(26)</td>
|
|
<td align="left" valign="top">Qualified sender job name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0602</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Sender type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0603</td>
|
|
<td align="left" valign="top">CHAR(12)</td>
|
|
<td align="left" valign="top">Sending program name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0604</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Sending module name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0605</td>
|
|
<td align="left" valign="top">CHAR(256)</td>
|
|
<td align="left" valign="top">Sending procedure name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0606</td>
|
|
<td align="left" valign="top">BINARY(4) followed by ARRAY(*) of CHAR(10)</td>
|
|
<td align="left" valign="top">Number of sending statement numbers or
|
|
instruction numbers available followed by an array of the sending statement
|
|
numbers or instruction numbers</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0607</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Sending user profile</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0702</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Receiving type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0703</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Receiving program name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0704</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Receiving module name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0705</td>
|
|
<td align="left" valign="top">CHAR(256)</td>
|
|
<td align="left" valign="top">Receiving procedure name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0706</td>
|
|
<td align="left" valign="top">BINARY(4) followed by ARRAY(*) of CHAR(10)</td>
|
|
<td align="left" valign="top">Number of receiving statement numbers or
|
|
instruction numbers available followed by an array of the receiving statement
|
|
numbers or instruction numbers</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0801</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Message file library used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">0901</td>
|
|
<td align="left" valign="top">CHAR(30)</td>
|
|
<td align="left" valign="top">Problem identification</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1001</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reply status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1002</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Critical break message status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1101</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Request status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1201</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Request level</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1301</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Coded character set identifier (CCSID) for
|
|
text</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1302</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Coded character set identifier (CCSID) conversion
|
|
status indicator for text</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1303</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Coded character set identifier (CCSID) for
|
|
data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1304</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Coded character set identifier (CCSID) conversion
|
|
status indicator for data</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRLSTFD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Alert option.</strong> Whether and when an SNA alert is created and
|
|
sent for the message. If a message is listed, the value is one of the
|
|
following:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*DEFER</em></td>
|
|
<td align="left" valign="top">An alert is sent after local problem
|
|
analysis.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*IMMED</em></td>
|
|
<td align="left" valign="top">An alert is sent immediately when the message is
|
|
sent to a message queue that has the allow alerts attribute set to *YES.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NO</em></td>
|
|
<td align="left" valign="top">No alert is sent.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*UNATTEND</em></td>
|
|
<td align="left" valign="top">An alert is sent immediately when the system is
|
|
running in unattended mode (when the value of the alert status network
|
|
attribute, ALRSTS, is *UNATTEND).</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>For more information on alerts, see the <a href="../books/sc415413.pdf"
|
|
target="_blank">Alerts Support</a> <img src="wbpdf.gif" alt="Link to PDF">
|
|
book.</p>
|
|
|
|
<p>This field is set to blanks if no alert option was specified when the
|
|
message was sent.</p>
|
|
|
|
<p><strong>CCSID conversion status indicator for data.</strong> The following
|
|
values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">No conversion was needed because the CCSID of the
|
|
data matched the CCSID you wanted the data converted to.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">No conversion occurred because either the data
|
|
was 65535 or the CCSID you wanted the data converted to was 65535.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">No conversion occurred because you did ask for
|
|
any data to be returned, or there was no *CCHAR type data.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">The data was converted to the CCSID specified
|
|
using the best fit conversion tables.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">A conversion error occurred using the best fit
|
|
conversion tables so a default conversion was attempted. This completed without
|
|
error.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>-1</em></td>
|
|
<td align="left" valign="top">An error occurred on both the best fit and
|
|
default conversions. The data was not converted.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>CCSID conversion status indicator for text.</strong> The following
|
|
values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">No conversion was needed because the CCSID of the
|
|
text matched the CCSID you wanted the text converted to.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">No conversion occurred because either the text
|
|
was 65535 or the CCSID you wanted the text converted to was 65535.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">No conversion occurred because you did not ask
|
|
for any text to be returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">The text was converted to the CCSID specified
|
|
using the best fit conversion tables.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">A conversion error occurred using the best fit
|
|
conversion tables so a default conversion was attempted. This completed without
|
|
error.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>-1</em></td>
|
|
<td align="left" valign="top">An error occurred on both the best fit and
|
|
default conversions. The data was not converted.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Coded character set identifier (CCSID) for data.</strong> The coded
|
|
character set identifier that the data is returned in. If a conversion error
|
|
occurs or if the CCSID you requested the data to be converted to is 65535, the
|
|
CCSID of the data is returned. If there is no *CCHAR replacement data, 65535 is
|
|
returned. Otherwise the CCSID you wanted the data converted to is returned.</p>
|
|
|
|
<p>This only applies to the part of the replacement data that corresponds to a
|
|
convertible character data type (*CCHAR).</p>
|
|
|
|
<p>For more information about message handler and its use of CCSIDs, see <a
|
|
href="../nls/rbagsccsidmsgsup2.htm">CCSIDs: Message Support</a> in the
|
|
Globalization topic.</p>
|
|
|
|
<p><strong>Coded character set identifier (CCSID) for text.</strong> The coded
|
|
character set identifier that the message text is returned in. If a conversion
|
|
error occurs or if the CCSID you requested the message text to be converted to
|
|
is 65535, the CCSID that the message text is stored in is returned. Otherwise
|
|
the CCSID you wanted your message text converted to is returned. If you do not
|
|
want the message text converted before it is returned to you but you do want to
|
|
know the CCSID that the message text is stored in, specify 65535 on the Coded
|
|
character set identifier to return text and data in parameter. The CCSID that
|
|
the message text is stored in is returned in the Coded character set identifier
|
|
for text output field.</p>
|
|
|
|
<p>This applies to the following fields only:</p>
|
|
|
|
<ul>
|
|
<li>Message</li>
|
|
|
|
<li>Message with replacement data</li>
|
|
|
|
<li>Message help</li>
|
|
|
|
<li>Message help with replacement data</li>
|
|
|
|
<li>Message help with replacement data and formatting characters</li>
|
|
|
|
<li>Message help with formatting characters</li>
|
|
</ul>
|
|
|
|
<p><strong>Note:</strong> This CCSID value does not apply to the replacement
|
|
data that has been substituted into the text. See the Coded character set
|
|
identifier for data for this information.</p>
|
|
|
|
<p><strong>Coded character set identifier (CCSID) to return text and data
|
|
in.</strong> The CCSID that the text and data are converted to before they are
|
|
returned. The following values are allowed:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The text and data are converted to the CCSID of
|
|
the job before being returned. This is the default value used when the MSLT0100
|
|
format is specified.
|
|
|
|
<p>If the job is 65535 and the text or data is something other than EBCDIC
|
|
single byte or EBCDIC mixed, the text and data are converted to the default job
|
|
CCSID.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>65535</em></td>
|
|
<td valign="top">The text and data are not converted before being
|
|
returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>CCSID</em></td>
|
|
<td valign="top">Specify a valid CCSID you want your text and data converted to
|
|
before being returned. The CCSID must be between 1 and 65535. Only CCSIDs that
|
|
a job can be changed to are accepted. The CCSID is validated by this API. For a
|
|
list of valid CCSIDs, see <a href="../nls/rbagsccsidmsgsup2.htm">CCSIDs:
|
|
Message Support</a>.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Coded character set identifier (CCSID) specified.</strong> The CCSID
|
|
that was specified that the text and data are converted to before they are
|
|
returned.</p>
|
|
|
|
<p><strong>Coded character set identifier (CCSID) used.</strong> The CCSID that
|
|
was used that the text and data are converted to before they are returned.</p>
|
|
|
|
<p><strong>Critical break message status.</strong> Whether the message was sent
|
|
by the operating system as a critical break message. The following values are
|
|
returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The message was sent as a critical break
|
|
message.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The message was not sent as a critical break
|
|
message.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Data.</strong> The data returned for the specified identifier
|
|
field.</p>
|
|
|
|
<p><strong>Date sent.</strong> The date on which the message was sent, in
|
|
CYYMMDD (century, year, month, and day) format.</p>
|
|
|
|
<p><strong>Date and time criteria.</strong> The date and time starting point
|
|
for messages to be listed. This is optional and must be blanks if not
|
|
specified. The search for messages to list begins from the message that is
|
|
specified by the starting message key. If the date and time criteria is
|
|
specified in the call to the API and the list direction is *PRV, then only
|
|
messages whose time of arrival on the queue is equal to or less than the date
|
|
and time criteria that is specified are listed. Similarly, if the direction is
|
|
*NEXT and the date and time criteria is specified on the call to the API, then
|
|
only those messages whose time of arrival on the queue is equal to or greater
|
|
than that specified are listed. The format of this field is in the
|
|
CYYMMDDHHMMSS as follows:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>C</em></td>
|
|
<td align="left" valign="top">Century, where 0 indicates years 19<em>xx</em>
|
|
and 1 indicates years 20<em>xx</em>.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>YY</em></td>
|
|
<td align="left" valign="top">Year</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>MM</em></td>
|
|
<td align="left" valign="top">Month</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>DD</em></td>
|
|
<td align="left" valign="top">Day</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>HH</em></td>
|
|
<td align="left" valign="top">Hour</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>MM</em></td>
|
|
<td align="left" valign="top">Minute</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>SS</em></td>
|
|
<td align="left" valign="top">Second</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Date and time criteria specified.</strong> The date and time
|
|
criteria as specified on the call to the API.</p>
|
|
|
|
<p><strong>Date and time of first message listed.</strong> The date and time of
|
|
the first message that is actually listed by the API. If no message is actually
|
|
listed by the API, this field is blank.</p>
|
|
|
|
<p><strong>Date and time of last message listed.</strong> The date and time of
|
|
the last message that is actually listed by the API. If no message is actually
|
|
listed by the API, this field is blank.</p>
|
|
|
|
<p><strong>Default reply.</strong> The text of the default reply. When a stored
|
|
message is being listed and a default reply exists. If this is not an inquiry
|
|
message or no default reply exists, this field is not used and the length of
|
|
data field is 0.</p>
|
|
|
|
<p><strong>Ending message key used.</strong> The message keys of the last
|
|
message actually listed by the API. If no message is listed from a particular
|
|
queue, the value returned for that queue is the same as that in the starting
|
|
message key specified field.</p>
|
|
|
|
<p><strong>Format of message selection information specified.</strong> The
|
|
format name of the message selection information parameter as specified on the
|
|
call to the API.</p>
|
|
|
|
<p><strong>Format name specified.</strong> The format name as specified on the
|
|
call to the API.</p>
|
|
|
|
<p><strong>Identifier field.</strong> The field returned. See <a href=
|
|
"#HDRLIDS">Valid Field Identifiers</a> for the list of valid field
|
|
identifiers.</p>
|
|
|
|
<p><strong>Identifiers of fields to return.</strong> The list of the field
|
|
identifiers to be returned in the LSTM0100 format. For a list of the valid
|
|
field identifiers, see <a href="#HDRLIDS">Valid Field Identifiers</a>. An error
|
|
is returned if the identifier matches one specified earlier in the array, or if
|
|
the identifier is not valid.</p>
|
|
|
|
<p><strong>Identifiers of fields to return specified.</strong> The list of
|
|
field identifiers to return as specified on the call to the API.</p>
|
|
|
|
<p><strong>Length of data.</strong> The length of the data returned for the
|
|
data field, in bytes.</p>
|
|
|
|
<p><strong>Length of field information returned.</strong> The total length of
|
|
information returned for this field, in bytes.</p>
|
|
|
|
<p><strong>List direction.</strong> The direction to list messages. You must
|
|
use one of these directions:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NEXT</em></td>
|
|
<td align="left" valign="top">Returns messages that are newer than the messages
|
|
specified by the starting message key field.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*PRV</em></td>
|
|
<td align="left" valign="top">Returns messages that are older than the message
|
|
specified by the starting message key field.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If multiple message queues are to be listed, messages are intermixed and
|
|
sorted by date and time in the specified manner.</p>
|
|
|
|
<p><strong>List direction specified.</strong> The direction to list messages as
|
|
specified on the call to the API.</p>
|
|
|
|
<p><strong>Maximum message help length.</strong> The maximum number of
|
|
characters of text that this API returns for field identifiers 0401, 0402,
|
|
0403, and 0404. (See <a href="#HDRLIDS">Valid Field Identifiers</a>.)</p>
|
|
|
|
<p>Specify a value to limit the number of characters returned for field
|
|
identifiers 0401, 0402, 0403, and 0404. This value can be no smaller than 4.
|
|
The maximum allowed value is 32765. To specify that the maximum length be used,
|
|
use the special value of -1. This value is not checked if field identifiers
|
|
0401, 0402, 0403, or 0404 are not specified.</p>
|
|
|
|
<p><strong>Maximum message help length specified.</strong> The maximum number
|
|
of characters to return for field identifiers 0401, 0402, 0403, and 0404 as
|
|
specified on the call to the API.</p>
|
|
|
|
<p><strong>Maximum message length.</strong> The maximum number of characters of
|
|
text that this API returns for field identifiers 0301 and 0302. (See <a href=
|
|
"#HDRLIDS">Valid Field Identifiers</a>.)</p>
|
|
|
|
<p>Specify a value to limit the number of characters returned for field
|
|
identifiers 0301 and 0302. This value can be no smaller than 4. The maximum
|
|
allowed value is 32765. To specify that the maximum length be used, use the
|
|
special value of -1. This value is not checked if field identifiers 0301 or
|
|
0302 are not specified.</p>
|
|
|
|
<p><strong>Maximum message length specified.</strong> The maximum number of
|
|
characters to return for field identifiers 0301 and 0302 as specified on the
|
|
call to the API.</p>
|
|
|
|
<p><strong>Maximum messages requested.</strong> The maximum number of messages
|
|
to be returned.</p>
|
|
|
|
<p>If fewer messages than the number requested exist on the queues, only the
|
|
number of messages that exist are returned. No error is signaled, and the
|
|
information status field in the generic header would be marked as C for
|
|
complete and accurate.</p>
|
|
|
|
<p>Use the special value of -1 to list all messages on the queues in the
|
|
specified list direction. The list runs from the starting message keys that
|
|
meet the selection and severity criteria.</p>
|
|
|
|
<p><strong>Maximum messages requested specified.</strong> The number of
|
|
messages requested to be listed as specified on the call to the API.</p>
|
|
|
|
<p><strong>Message.</strong> The text of a predefined message without
|
|
replacement data substitution. If an impromptu message is listed, this field
|
|
contains the impromptu message text.</p>
|
|
|
|
<p><strong>Message file library specified at send time.</strong> The name of
|
|
the library containing the message file as specified when the message was sent.
|
|
If *CURLIB or *LIBL was specified for the library when the message was sent,
|
|
that value is returned as the library here. For the actual library used when
|
|
the message is sent, see the message file library used field.</p>
|
|
|
|
<p><strong>Message file library used.</strong> The actual name of the library
|
|
that contains the message file used to retrieve the message information. If an
|
|
immediate message is listed, this field is set to blanks.</p>
|
|
|
|
<p><strong>Message file name.</strong> The name of the message file containing
|
|
the message listed.</p>
|
|
|
|
<p><strong>Message help.</strong> The message help for the message listed
|
|
without formatting characters and without replacement data. If an impromptu
|
|
message is listed, this field contains the impromptu message text.</p>
|
|
|
|
<p><strong>Message help with formatting characters.</strong> The message help
|
|
for the message listed, including formatting characters.</p>
|
|
|
|
<p>Three format control characters can be returned within the message. They are
|
|
defined in the online help for the Add Message Description (ADDMSGD) command to
|
|
have these meanings:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>&N</em></td>
|
|
<td align="left" valign="top">Forces the text to a new line (column 2). If the
|
|
text is longer than one line, the next lines are indented to column 4 until the
|
|
end of text or another format control character is found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>&P</em></td>
|
|
<td align="left" valign="top">Forces the text to a new line indented to column
|
|
6. If the text is longer than one line, the next lines start in column 4 until
|
|
the end of text or another format control character is found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>&B</em></td>
|
|
<td align="left" valign="top">Forces the text to a new line, starting in column
|
|
4. If the text is longer than one line, the next lines are indented to column 6
|
|
until the end of text or another format control character is found.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If an impromptu message is listed, this field contains the impromptu message
|
|
text.</p>
|
|
|
|
<p><strong>Message help with replacement data.</strong> The message help for
|
|
the message listed, including the replacement data. If an impromptu message is
|
|
listed, this field contains the impromptu message text.</p>
|
|
|
|
<p><strong>Message help with replacement data and formatting
|
|
characters.</strong> The message help for the message listed, including the
|
|
replacement data and the formatting characters. See the message help with
|
|
formatting characters field for an explanation of formatting characters. If an
|
|
impromptu message is listed, this field contains the impromptu message
|
|
text.</p>
|
|
|
|
<p><strong>Message identifier.</strong> The identifying code of the message
|
|
listed. If an impromptu message is listed, this field is set to blanks.</p>
|
|
|
|
<p><strong>Message key.</strong> The key of the message listed.</p>
|
|
|
|
<p><strong>Message queue.</strong> The name of the message queue where the
|
|
message was listed.</p>
|
|
|
|
<p><strong>Message queue library used.</strong> The actual library that
|
|
contains the message queue.</p>
|
|
|
|
<p><strong>Message queue names specified.</strong> The qualified message queue
|
|
names specified on the call to the API.</p>
|
|
|
|
<p><strong>Message queue names used.</strong> The actual message queue names
|
|
used to list messages. The first 10 characters are the message queue name, and
|
|
the second 10 characters are the message queue library.</p>
|
|
|
|
<p><strong>Message severity.</strong> The severity of the message listed.
|
|
Possible values are 0 through 99.</p>
|
|
|
|
<p><strong>Message type.</strong> The type of message listed. The possible
|
|
values and their meanings follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<tr>
|
|
<th align="left" valign="top">Value</th>
|
|
<th align="left" valign="top">Message Type</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">01</td>
|
|
<td align="left" valign="top" width="85%">Completion</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">02</td>
|
|
<td align="left" valign="top">Diagnostic</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">04</td>
|
|
<td align="left" valign="top">Informational</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">05</td>
|
|
<td align="left" valign="top">Inquiry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">06</td>
|
|
<td align="left" valign="top">Sender's copy</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">08</td>
|
|
<td align="left" valign="top">Request</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">10</td>
|
|
<td align="left" valign="top">Request with prompting</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">14</td>
|
|
<td align="left" valign="top">Notify, exception already handled when API is
|
|
called</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">15</td>
|
|
<td align="left" valign="top">Escape, exception already handled when API is
|
|
called</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">16</td>
|
|
<td align="left" valign="top">Notify, exception not handled when API is
|
|
called</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">17</td>
|
|
<td align="left" valign="top">Escape, exception not handled when API is
|
|
called</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">21</td>
|
|
<td align="left" valign="top">Reply, not checked for validity</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">22</td>
|
|
<td align="left" valign="top">Reply, checked for validity</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">23</td>
|
|
<td align="left" valign="top">Reply, message default used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">24</td>
|
|
<td align="left" valign="top">Reply, system default used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">25</td>
|
|
<td align="left" valign="top">Reply, from system reply list</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">26</td>
|
|
<td align="left" valign="top">Reply, from exit program</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<p><strong>Message with replacement data.</strong> The text of a predefined
|
|
message with the replacement data included. If an impromptu message is listed,
|
|
this field contains the impromptu message text.</p>
|
|
|
|
<p><strong>Microseconds.</strong> The microseconds part of the time sent.</p>
|
|
|
|
<p><strong>Number of fields returned.</strong> The number of identifier fields
|
|
returned to the application.</p>
|
|
|
|
<p><strong>Number of fields to return.</strong> The number of fields to return
|
|
in the LSTM0100 format (the number of entries in the identifiers of fields to
|
|
return array).</p>
|
|
|
|
<p><strong>Number of fields to return specified.</strong> The number of
|
|
identifier fields to return as specified on the call to the API.</p>
|
|
|
|
<p><strong>Number of message queues.</strong> The number of message queues to
|
|
list. The valid values follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">One message queue listed. Both the qualified
|
|
message queue names field and the starting message key field contain one
|
|
entry.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Two message queues listed. Both the qualified
|
|
message queue names field and the starting message key field contain two
|
|
entries.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Number of message queues specified.</strong> The number of message
|
|
queues to be listed as specified on the call to the API. This is the size of
|
|
the declared array of the message queue names specified and the starting
|
|
message key specified fields.</p>
|
|
|
|
<p><strong>Number of message queues used.</strong> The number of message queues
|
|
listed. This is the number of elements in the message queue names used,
|
|
starting message key used, and ending message key arrays.</p>
|
|
|
|
<p><strong>Number of receiving statement numbers or instruction numbers
|
|
available followed by an array of the receiving statement numbers or
|
|
instruction numbers.</strong> This field can be specified for the QMHLSTM API,
|
|
but it never returns any data and the length of data field is 0.</p>
|
|
|
|
<p><strong>Number of sending statement numbers or instruction numbers available
|
|
followed by an array of the sending statement numbers or instruction
|
|
numbers.</strong> This field can be specified for the QMHLSTM API, but it never
|
|
returns any data and the length of data field is 0.</p>
|
|
|
|
<p><strong>Offset to ending message key.</strong> The offset, in bytes, from
|
|
the beginning of the user space to the beginning of the ending message key
|
|
field.</p>
|
|
|
|
<p><strong>Offset to fields returned.</strong> The offset, in bytes, from the
|
|
beginning of the user space to the beginning of the first repeating identified
|
|
field of the LSTM0100 format.</p>
|
|
|
|
<p><strong>Offset to identifiers of fields to return.</strong> The offset, in
|
|
bytes, from the beginning of the message selection information parameter to the
|
|
beginning of the identifiers of fields to return field.</p>
|
|
|
|
<p><strong>Offset to identifiers of fields to return specified.</strong> The
|
|
offset, in bytes, from the beginning of the user space to the beginning of the
|
|
identifiers of fields to return specified field.</p>
|
|
|
|
<p><strong>Offset to message queue names specified.</strong> The offset, in
|
|
bytes, from the beginning of the user space to the beginning of the message
|
|
queue names specified field.</p>
|
|
|
|
<p><strong>Offset to message queue names used.</strong> The offset, in bytes,
|
|
from the beginning of the user space to the beginning of the message queue
|
|
names used field.</p>
|
|
|
|
<p><strong>Offset to qualified message queue names.</strong> The offset, in
|
|
bytes, from the beginning of the message selection information parameter to the
|
|
beginning of the qualified message queue names field.</p>
|
|
|
|
<p><strong>Offset to starting message keys.</strong> The offset, in bytes, from
|
|
the beginning of the message selection information parameter to the beginning
|
|
of the starting message key field.</p>
|
|
|
|
<p><strong>Offset to starting message key specified.</strong> The offset, in
|
|
bytes, from the beginning of the user space to the beginning of the starting
|
|
message key specified field.</p>
|
|
|
|
<p><strong>Offset to starting message key used.</strong> The offset, in bytes,
|
|
from the beginning of the user space to the beginning of the starting message
|
|
key used field.</p>
|
|
|
|
<p><strong>Offset to the next entry.</strong> The offset, in bytes, from the
|
|
beginning of the user space to the beginning of the next message entry.</p>
|
|
|
|
<p><strong>Offset to the next field information returned.</strong> The offset,
|
|
in bytes, from the beginning of the user space to the beginning of the next
|
|
repeating identified field of the LSTM0100 format.</p>
|
|
|
|
<p><strong>Problem identification.</strong> The number the system generates to
|
|
identify a problem if problem analysis can be run for the message being listed.
|
|
The problem identification is in the following format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>CHAR 1-10</em></td>
|
|
<td align="left" valign="top">Problem ID number. The number the system
|
|
generates to identify the problem.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>CHAR 11-30</em></td>
|
|
<td align="left" valign="top">Origin system in the format <em>
|
|
network-ID.control-point-name</em>.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If problem analysis cannot be run, and this field is specified, the length
|
|
of data field is 0.</p>
|
|
|
|
<p><strong>Qualified message queue names.</strong> The list of message queues
|
|
and the libraries where the message queues are located. The number of entries
|
|
in the array must match the number specified in the number of message queues
|
|
field. The first 10 characters of each entry contain the message queue name,
|
|
and the second 10 characters of each entry contain the message queue library.
|
|
You can use the following values for the library name:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
|
<td align="left" valign="top">The job's current library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">The library list</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Qualified sender job name.</strong> The name of the job that sent
|
|
the message. The job name has three parts:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>CHAR 1-10</em></td>
|
|
<td align="left" valign="top">The specific job name.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>CHAR 11-20</em></td>
|
|
<td align="left" valign="top">The specific user profile name.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>CHAR 21-26</em></td>
|
|
<td align="left" valign="top">The specific job number.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Receiving module name.</strong> This field can be specified for the
|
|
QMHLSTM API, but it never returns any data and the length of data field is
|
|
0.</p>
|
|
|
|
<p><strong>Receiving procedure name.</strong> This field can be specified for
|
|
the QMHLSTM API, but it never returns any data and the length of data field is
|
|
0.</p>
|
|
|
|
<p><strong>Receiving program name.</strong> This field can be specified for the
|
|
QMHLSTM API, but it never returns any data and the length of data field is
|
|
0.</p>
|
|
|
|
<p><strong>Receiving type.</strong> This field can be specified for the QMHLSTM
|
|
API, but it never returns any data and the length of data field is 0.</p>
|
|
|
|
<p><strong>Replacement data or impromptu message text.</strong> The values for
|
|
replacement variables in a predefined message, or the text of an impromptu
|
|
message. If the message identifier field is not blank, this field contains
|
|
message data. If the message identifier field is blank, this field contains
|
|
impromptu message text.</p>
|
|
|
|
<p>Any pointer data in this field is marked as not valid if both:</p>
|
|
|
|
<ul>
|
|
<li>The API is called by a call stack entry not running in system state.</li>
|
|
|
|
<li>The system security level is 50 or above.</li>
|
|
</ul>
|
|
|
|
<p><strong>Reply status.</strong> The reply status of the message (whether it
|
|
accepts a reply, and if so, whether a reply has been sent). Possible values and
|
|
their meanings follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>A</em></td>
|
|
<td align="left" valign="top">Message accepts a reply, and a reply has been
|
|
sent.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>W</em></td>
|
|
<td align="left" valign="top">Message accepts a reply, and a reply has not been
|
|
sent. (The message is waiting for a reply.)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>N</em></td>
|
|
<td align="left" valign="top">Message does not accept a reply.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Request level.</strong> This field can be specified for the QMHLSTM
|
|
API, but it never returns any data and the length of data field is 0.</p>
|
|
|
|
<p><strong>Request status.</strong> This field can be specified for the QMHLSTM
|
|
API, but it never returns any data the length of data field is 0.</p>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>Selection criteria.</strong> The type of messages to be listed.
|
|
Valid values follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All messages are to be listed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*MNNR</em></td>
|
|
<td align="left" valign="top">Only messages not requiring a reply are listed.
|
|
This includes informational, completion, diagnostic, request, notify, escape,
|
|
reply, answered inquiry, and answered sender's copy messages.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*MNR</em></td>
|
|
<td align="left" valign="top">Only messages needing a reply are listed. This
|
|
includes only unanswered inquiry messages.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*PAR</em></td>
|
|
<td align="left" valign="top">Only messages that can have problem analysis run
|
|
against them are listed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SCNR</em></td>
|
|
<td align="left" valign="top">Only sender's copy messages requiring a reply are
|
|
listed. This includes only unanswered sender's copy messages.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Selection criteria specified.</strong> The selection criteria as
|
|
specified on the call to the API.</p>
|
|
|
|
<p><strong>Sender type.</strong> This field can be specified for the QMHLSTM
|
|
API, but it never returns any data and the length of data field is 0.</p>
|
|
|
|
<p><strong>Sending module name.</strong> This field can be specified for the
|
|
QMHLSTM API, but it never returns any data and the length of data field is
|
|
0.</p>
|
|
|
|
<p><strong>Sending procedure name.</strong> This field can be specified for the
|
|
QMHLSTM API, but it never returns any data and the length of data field is
|
|
0.</p>
|
|
|
|
<p><strong>Sending program name.</strong> The sending program name or ILE
|
|
program name that contains the procedure sending the message. Under certain
|
|
conditions, the actual name of the program that sent the message is not known.
|
|
In these cases, this field contains the 6-byte hexadecimal address of the
|
|
program converted into 12 displayable characters. In all other cases, the
|
|
10-character program name is returned left-justified in the field; the final 2
|
|
characters contain blanks.</p>
|
|
|
|
<p><strong>Sending statement numbers or instruction numbers.</strong> This
|
|
field can be specified for the QMHLSTM API, but it never returns any data and
|
|
the length of data field is 0.</p>
|
|
|
|
<p><strong>Sending user profile.</strong> The name of the user profile that the thread
|
|
was running under when the message was sent.</p>
|
|
|
|
<p><strong>Severity criteria.</strong> The minimum severity of a message to be
|
|
included in the list. The value must be between 0 and 99. To retrieve all
|
|
messages, specify a severity criteria of 0.</p>
|
|
|
|
<p><strong>Severity criteria specified.</strong> The severity criteria as
|
|
specified on the call to the API.</p>
|
|
|
|
<p><strong>Size of message selection information specified.</strong> The size
|
|
of the message selection information field, in bytes, as specified in the call
|
|
to the API.</p>
|
|
|
|
<p><strong>Starting message key.</strong> The message key used to begin
|
|
searching for messages to list from the corresponding entry in the qualified
|
|
message queue names field. You can use these special values for the message
|
|
keys:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'00000000'X</em></td>
|
|
<td align="left" valign="top">The first message to be returned is the oldest
|
|
message in the queue.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'FFFFFFFF'X</em></td>
|
|
<td align="left" valign="top">The first message to be returned is the newest
|
|
message in the queue.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If a value other than X'00000000' or X'FFFFFFFF' is specified and a message
|
|
with that key does not exist, an error is returned.</p>
|
|
|
|
<p>If the message that is specified by the starting message key exists but does
|
|
not meet the selection criteria, the severity criteria, or the date and time
|
|
criteria fields that are specified, no error is returned. The search for
|
|
messages to list begins from the message that is specified by the starting
|
|
message key.</p>
|
|
|
|
<p><strong>Starting message key specified.</strong> The starting message keys
|
|
as specified on the call to the API.</p>
|
|
|
|
<p><strong>Starting message key used.</strong> The message keys of the first
|
|
message actually listed by the API. If no message is listed from a particular
|
|
message queue, the value returned for that queue is the same as that in the
|
|
starting message key specified field.</p>
|
|
|
|
<p><strong>Status of data.</strong> The status of the data listed for this
|
|
message. Possible values and their meanings follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>blank</em></td>
|
|
<td align="left" valign="top">The data returned is complete.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>A</em></td>
|
|
<td align="left" valign="top">The caller of the API was not authorized to view
|
|
the data. This occurs when the caller of the API is not authorized to the
|
|
message file or message file library containing a stored message being
|
|
listed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>D</em></td>
|
|
<td align="left" valign="top">The data was damaged. This occurs when the
|
|
message file or library specified at send time for a stored message is damaged
|
|
when the API is called.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>U</em></td>
|
|
<td align="left" valign="top">The data was unavailable. This occurs when the
|
|
message file or library specified at send time for a stored message is
|
|
exclusively used by another process when the API is called.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>N</em></td>
|
|
<td align="left" valign="top">The data was not found. This occurs when the
|
|
message file or library specified at send time for a stored message cannot be
|
|
found or resolved when the API is called.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This field is applicable to the field identifiers that are retrieved from
|
|
the message file for a stored message. A description of the action that occurs
|
|
for specific field identifiers when the status of data field is not blank
|
|
follows:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0101</em></td>
|
|
<td align="left" valign="top">When the status of data field is not blank, the
|
|
alert option field identifier contains blanks.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0301, 0302</em></td>
|
|
<td align="left" valign="top">When the status of data field is not blank, these
|
|
message field identifiers contain message text. regarding the problem
|
|
encountered while attempting to access the message file. Both fields have the
|
|
replacement data substituted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0401, 0402, 0403, 0404</em></td>
|
|
<td align="left" valign="top">When the status of data field is not blank, these
|
|
message help field identifiers contain the text of the message regarding the
|
|
problem encountered while attempting to access the message file. All fields
|
|
have the replacement data substituted. The message help with formatting
|
|
characters and message help with replacement data and formatting characters
|
|
field identifiers also have the message formatting characters included.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0501</em></td>
|
|
<td align="left" valign="top">When the status of data field is not blank, the
|
|
default reply field identifier contains the system default reply.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0801</em></td>
|
|
<td align="left" valign="top">When the status of data field is not blank, the
|
|
message file library used field identifier contains blanks.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This field is also applicable to the various sending information fields
|
|
(identifiers 0601, 0603) when a problem is encountered while attempting to
|
|
retrieve this information. When one of these fields cannot be retrieved from
|
|
the message:</p>
|
|
|
|
<ul>
|
|
<li>The status of data field is set to N.</li>
|
|
|
|
<li>The length of data field is set to 0.</li>
|
|
</ul>
|
|
|
|
<p>The status of data field is always blank for the other field identifiers.
|
|
The length of data field is zero.</p>
|
|
|
|
<p><strong>Time sent.</strong> The time at which the message being listed was
|
|
sent, in HHMMSS (hour, minute, and second) format.</p>
|
|
|
|
<p><strong>Type of data.</strong> The type of data returned.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>C</em></td>
|
|
<td align="left" valign="top">The data is returned in character format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>B</em></td>
|
|
<td align="left" valign="top">The data is returned in binary format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>M</em></td>
|
|
<td align="left" valign="top">The data is returned in a mixed format. This
|
|
value is returned for the field IDs 0606 and 0706.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>User space library specified.</strong> The name of the user space
|
|
library as specified on the call to the API.</p>
|
|
|
|
<p><strong>User space library used.</strong> The actual name of the library
|
|
where this user space was found.</p>
|
|
|
|
<p><strong>User space name specified.</strong> The name of the user space as
|
|
specified on the call to the API.</p>
|
|
|
|
<p><strong>User space name used.</strong> The actual name of the user space
|
|
used to store the data listed.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="3">
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF1060 E</td>
|
|
<td width="85%" valign="top">Date not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF1061 E</td>
|
|
<td align="left" valign="top">Time not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF1866 E</td>
|
|
<td align="left" valign="top">Value &1 for number of fields to return not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
|
<td align="left" valign="top">Severe error while addressing parameter
|
|
list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF240D E</td>
|
|
<td align="left" valign="top">Message search direction specified is not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF240E E</td>
|
|
<td align="left" valign="top">Format name of message selection information is
|
|
not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF240F E</td>
|
|
<td align="left" valign="top">Field identifier is not valid or is a duplicate
|
|
of another field</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2401 E</td>
|
|
<td align="left" valign="top">Not authorized to library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2403 E</td>
|
|
<td align="left" valign="top">Message queue &1 in &2 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2408 E</td>
|
|
<td align="left" valign="top">Not authorized to message queue &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF241D E</td>
|
|
<td align="left" valign="top">Severity criteria specified is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF241F E</td>
|
|
<td align="left" valign="top">Length &1 specified for maximum message
|
|
length is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2410 E</td>
|
|
<td align="left" valign="top">Message key not found in message queue
|
|
&1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2433 E</td>
|
|
<td align="left" valign="top">Function not allowed for system log message queue
|
|
&1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2444 E</td>
|
|
<td align="left" valign="top">Number of message queues, &1, is not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2467 E</td>
|
|
<td align="left" valign="top">&3 message queue &1 in library &2
|
|
logically damaged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF247D E</td>
|
|
<td align="left" valign="top">Size of message selection information, &1, is
|
|
not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF247E E</td>
|
|
<td align="left" valign="top">CCSID &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2476 E</td>
|
|
<td align="left" valign="top">The maximum number of messages to list, &1,
|
|
is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2477 E</td>
|
|
<td align="left" valign="top">Message queue &1 currently in use.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF252F E</td>
|
|
<td align="left" valign="top">Length &1 specified for maximum message help
|
|
length is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2538 E</td>
|
|
<td align="left" valign="top">Value for selection criteria not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CAA E</td>
|
|
<td align="left" valign="top">List is too large for user space &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C39 E</td>
|
|
<td align="left" valign="top">Value for reserved field not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td align="left" valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF8198 E</td>
|
|
<td align="left" valign="top">Damaged object found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9807 E</td>
|
|
<td align="left" valign="top">One or more libraries in library list
|
|
deleted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9808 E</td>
|
|
<td align="left" valign="top">Cannot allocate one or more libraries on library
|
|
list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9811 E</td>
|
|
<td align="left" valign="top">Program &1 in library &2 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9812 E</td>
|
|
<td align="left" valign="top">File &1 in library &2 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9814 E</td>
|
|
<td align="left" valign="top">Device &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9821 E</td>
|
|
<td align="left" valign="top">Not authorized to program &1 in library
|
|
&2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9822 E</td>
|
|
<td align="left" valign="top">Not authorized to file &1 in library
|
|
&2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9825 E</td>
|
|
<td align="left" valign="top">Not authorized to device &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9830 E</td>
|
|
<td align="left" valign="top">Cannot assign library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9831 E</td>
|
|
<td align="left" valign="top">Cannot assign device &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9838 E</td>
|
|
<td align="left" valign="top">User profile storage limit exceeded.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library
|
|
&2 ended. Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<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=
|
|
"mh1.htm">Message Handling APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|