1852 lines
56 KiB
HTML
1852 lines
56 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>Open List of Job Log Messages (QGYOLJBL) 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>Open List of Job Log Messages (QGYOLJBL) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 75%;">
|
||
|
|
<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="50%">Receiver variable</td>
|
||
|
|
<td align="left" valign="top" width="20%">Output</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Length of receiver variable</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">List Information</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(80)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Number of records to return</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">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">6</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">7</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 Open List of Job Log Messages (QGYOLJBL) API lists messages from a job
|
||
|
|
log. The returned messages are sorted by their sending date and time unless the
|
||
|
|
message being listed is a reply message to an inquiry, a sender's copy, or a
|
||
|
|
notify type message. When a reply message exists for one of these messages, the
|
||
|
|
reply message is not positioned according to the sending date and time of the
|
||
|
|
reply. The reply message is, instead, listed immediately following the inquiry,
|
||
|
|
the sender's copy, or the notify message that it is associated with.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> The QTEMP library and the system portion of the
|
||
|
|
library list could be different between the main job and the server job when
|
||
|
|
the list is being built asynchronously. If this is a problem, request that the
|
||
|
|
list be built synchronously.</p>
|
||
|
|
|
||
|
|
<p>For more information, see <a href="misc1b.htm">Process Open List
|
||
|
|
APIs</a>.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Differences between QMHLJOBL and QGYOLJBL</h3>
|
||
|
|
|
||
|
|
<p>The differences between the QGYOLJBL API and the List Job Log Messages
|
||
|
|
(QMHLJOBL) API follow:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The message information for the QGYOLJBL API is returned into a receiver
|
||
|
|
variable instead of a user space.</li>
|
||
|
|
|
||
|
|
<li>The request handle parameter was added to the QGYOLJBL API, so that a
|
||
|
|
distinct value is associated with the list. This value ensures that a request
|
||
|
|
for more messages from the list (call QGYGTLE API) is sent to the correct
|
||
|
|
list.</li>
|
||
|
|
|
||
|
|
<li>The total records parameter was added to the QGYOLJBL API, so that the
|
||
|
|
caller of the API knows the size of the list from which information can be
|
||
|
|
requested.</li>
|
||
|
|
|
||
|
|
<li>The records returned parameter was added to the QGYOLJBL API. Now if the
|
||
|
|
request is for X records and only Y records exist (where Y < X), the
|
||
|
|
requestor is aware that it did not get the number of records requested.</li>
|
||
|
|
|
||
|
|
<li>The amount of information returned by the QMHLJOBL API is limited by the
|
||
|
|
size of a user space, approximately 16MB. The list created by the QGYOLJBL
|
||
|
|
API can contain up to 2GB of information.</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>User Space Lock</em></dt>
|
||
|
|
|
||
|
|
<dd>*EXCLRD</dd>
|
||
|
|
|
||
|
|
<dt><em>Job Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>
|
||
|
|
<ul>
|
||
|
|
<li>*JOBCTL special authority if the job for which messages are being listed has a different user
|
||
|
|
profile from that of the job that calls the QGYOLJBL API.</li>
|
||
|
|
|
||
|
|
<li>*ALLOBJ and *JOBCTL special authorities if the job for which messages are being retrieved has *ALLOBJ
|
||
|
|
and *JOBCTL special authority. As an alternative to having *ALLOBJ authority,
|
||
|
|
the user calling the API can be authorized to the All Object Job Log function
|
||
|
|
of Operating System/400 through iSeries Navigator's Application Administration
|
||
|
|
support. The Change Function Usage (CHGFCNUSG) command, with a function
|
||
|
|
ID of QIBM_ACCESS_ALLOBJ_JOBLOG, can also be used to change the list of users
|
||
|
|
that are allowed to access a job log that has *ALLOBJ special authority.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>For additional information on job authorities, see <a href=
|
||
|
|
"../rzamv/rzamvplansec.htm">Plan and set up system security</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Receiver variable</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The variable used to return the requested number of records containing
|
||
|
|
message information. See <a href="#HDROGRV">OLJL0100 Format</a> for a
|
||
|
|
description of this parameter.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the receiver variable.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>List information</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(80)
|
||
|
|
|
||
|
|
<p>The variable used to return status information about the list of job log
|
||
|
|
messages that was opened. For a description of this parameter, see <a href=
|
||
|
|
"../apiref/oli.htm">Format of Open List Information</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Number of records to return</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The number of records in the list to be put into the receiver variable.
|
||
|
|
Valid values for this field are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>-1</em></td>
|
||
|
|
<td align="left" valign="top">All records are built synchronously in the list
|
||
|
|
by the main job.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">All records are built asynchronously in the list
|
||
|
|
by a server job.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>If a positive number of records is specified, at least that many records are
|
||
|
|
built synchronously (in order to return those records immediately to the caller
|
||
|
|
of this API), and the remainder are built asynchronously by a server job.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Message selection information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The information that determines the job message queue and messages to be
|
||
|
|
listed. The format of this information is described in <a href="#HDRMSELC">
|
||
|
|
Message Selection Information 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. The
|
||
|
|
minimum value of this parameter is 85.</p>
|
||
|
|
</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><a name="HDROGRV">OLJL0100 Format</a></h3>
|
||
|
|
|
||
|
|
<p>For detailed descriptions of each field, see the <a href="#HDRRECVFI">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%">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(7)</td>
|
||
|
|
<td align="left" valign="top">Date sent</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">56</td>
|
||
|
|
<td align="center" valign="top">38</td>
|
||
|
|
<td align="left" valign="top">CHAR(6)</td>
|
||
|
|
<td align="left" valign="top">Time sent</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">62</td>
|
||
|
|
<td align="center" valign="top">3E</td>
|
||
|
|
<td align="left" valign="top">CHAR(6)</td>
|
||
|
|
<td align="left" valign="top">Microseconds</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">
|
||
|
|
<img src= "v5r4adelta.gif" alt="Start of change">68</td>
|
||
|
|
<td align="center" valign="top">44</td>
|
||
|
|
<td align="left" valign="top">CHAR(8)</td>
|
||
|
|
<td align="left" valign="top">Thread ID
|
||
|
|
<img src="v5r4adeltaend.gif" alt="End of change"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">
|
||
|
|
<img src= "v5r4adelta.gif" alt="Start of change">76</td>
|
||
|
|
<td align="center" valign="top">4C
|
||
|
|
<img src="v5r4adeltaend.gif" alt="End of change"></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="HDRRECVFI">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<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>Identifier field.</strong> The field ID actually returned in the
|
||
|
|
OLJL0100 format. See <a href="#HDRQDS2">Valid Field Identifiers</a> for the
|
||
|
|
list of valid field identifiers.</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>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 were 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 identifier.</p>
|
||
|
|
|
||
|
|
<p><strong>Message file name.</strong> The name of the message file containing
|
||
|
|
the message listed.</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 message reference key of the message
|
||
|
|
listed.</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">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<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>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>Offset to fields returned.</strong> The offset, in bytes, from the
|
||
|
|
beginning of the receiver variable to the beginning of the first repeating
|
||
|
|
identified field of the OLJL0100 format.</p>
|
||
|
|
|
||
|
|
<p><strong>Offset to the next entry.</strong> The offset, in bytes, from the
|
||
|
|
beginning of the receiver variable 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 receiver variable to the beginning of the
|
||
|
|
next repeating identified field of the OLJL0100 format.</p>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> An ignored 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 the 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 message text 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 and receiving
|
||
|
|
information fields when a problem is encountered while attempting to retrieve
|
||
|
|
this information. This includes field identifiers 0602, 0603, 0604, 0605, 0606,
|
||
|
|
0702, 0703, 0704, 0705, and 0706. When one of these fields cannot be retrieved
|
||
|
|
from the message, the status of data field is set to U and the field is set to
|
||
|
|
blanks.</p>
|
||
|
|
|
||
|
|
<p>The status of data field is always blank for the other field
|
||
|
|
identifiers.</p>
|
||
|
|
|
||
|
|
<p><img src= "v5r4adelta.gif" alt="Start of change">
|
||
|
|
<strong>Thread ID.</strong> The 8-byte thread ID of the thread in
|
||
|
|
which this message was sent.
|
||
|
|
<img src="v5r4adeltaend.gif" alt="End of change"></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, which contain a binary(4)
|
||
|
|
value followed by an array of 10-character elements.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRMSELC">Message Selection Information Format</a></h3>
|
||
|
|
|
||
|
|
<p>For detailed descriptions of each field, see the <a href="#HDRMSSFD">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%">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top" width="60%">List direction</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">10</td>
|
||
|
|
<td align="center" valign="top">A</td>
|
||
|
|
<td align="left" valign="top">CHAR(26)</td>
|
||
|
|
<td align="left" valign="top">Qualified job name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">36</td>
|
||
|
|
<td align="center" valign="top">24</td>
|
||
|
|
<td align="left" valign="top">CHAR(16)</td>
|
||
|
|
<td align="left" valign="top">Internal job identifier</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">52</td>
|
||
|
|
<td align="center" valign="top">34</td>
|
||
|
|
<td align="left" valign="top">CHAR(4)</td>
|
||
|
|
<td align="left" valign="top">Starting message key</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">Maximum message length</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">60</td>
|
||
|
|
<td align="center" valign="top">3C</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">64</td>
|
||
|
|
<td align="center" valign="top">40</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Offset of identifiers of fields to return</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">Number of fields to return</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">Offset to call message queue name</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">Size of call message queue name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" rowspan="2" colspan="2">The offsets to these
|
||
|
|
fields are specified in the previous offset variables.</td>
|
||
|
|
<td align="left" valign="top">ARRAY(*) of BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Identifiers of fields to return</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Call message queue name</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRMSSFD">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Call message queue name.</strong> The name of the call message queue
|
||
|
|
from which to list messages. You must use these values:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*</em></td>
|
||
|
|
<td align="left" valign="top">Messages from every call of the job are
|
||
|
|
listed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*EXT</em></td>
|
||
|
|
<td align="left" valign="top">Only messages sent to *EXT of the job are
|
||
|
|
listed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Identifiers of fields to return.</strong> The list of the
|
||
|
|
identifiers of fields to be returned. For a list of the valid field
|
||
|
|
identifiers, see <a href="#HDRQDS2">Valid Field Identifiers</a>.</p>
|
||
|
|
|
||
|
|
<p><strong>Internal job identifier.</strong> The internal name for the job. The
|
||
|
|
List Job (QUSLJOB) API creates this identifier. If you do not specify *INT for
|
||
|
|
the job name parameter, this parameter must contain blanks. With this
|
||
|
|
parameter, the system can locate the job more quickly than with a job name.</p>
|
||
|
|
|
||
|
|
<p><strong>List direction.</strong> The direction to list messages. You must
|
||
|
|
use one of the following directions:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*NEXT</em></td>
|
||
|
|
<td align="left" valign="top">Return messages that are newer than the message
|
||
|
|
specified by the starting message key parameter and the starting offset
|
||
|
|
parameter. This returns messages that start with the oldest first, and the most
|
||
|
|
recently sent message last.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*PRV</em></td>
|
||
|
|
<td align="left" valign="top">Return messages that are older than the messages
|
||
|
|
specified by the starting message key parameter. This returns messages that
|
||
|
|
start with the most recently sent message first, and the oldest message
|
||
|
|
last.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Maximum message help length.</strong> The maximum length of data to
|
||
|
|
be returned for field identifiers 0401, 0402, 0403, and 0404.</p>
|
||
|
|
|
||
|
|
<p><strong>Maximum message length.</strong> The maximum length of data to be
|
||
|
|
returned for field identifiers 0301 and 0302.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of fields to return.</strong> The number of fields to return
|
||
|
|
(the number of entries in the identifiers of fields to return array).</p>
|
||
|
|
|
||
|
|
<p>To avoid heavy utilization of system resources, users of this API must be
|
||
|
|
cautious of selecting too many fields to return for the messages that are
|
||
|
|
listed.</p>
|
||
|
|
|
||
|
|
<p><strong>Offset to call message queue name.</strong> The offset, in bytes,
|
||
|
|
from the beginning of the message selection information parameter to the
|
||
|
|
beginning of the call message queue name field.</p>
|
||
|
|
|
||
|
|
<p><strong>Offset of 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 array.</p>
|
||
|
|
|
||
|
|
<p><strong>Qualified job name.</strong> The name of the job whose messages are
|
||
|
|
to be listed. The qualified job name has three parts:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>Job name</em></td>
|
||
|
|
<td align="left" valign="top">CHAR(10)A specific job name or one of the
|
||
|
|
following special values:
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*</em></td>
|
||
|
|
<td align="left" valign="top">The job that this program is running in. The rest
|
||
|
|
of the qualified job name parameter must be blank.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*INT</em></td>
|
||
|
|
<td align="left" valign="top">The internal job identifier locates the job. The
|
||
|
|
rest of the qualified job name parameter must be blank.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>User name</em></td>
|
||
|
|
<td align="left" valign="top">CHAR(10) A specific user profile name, or blanks
|
||
|
|
when the job name is the special value of * or *INT.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>Job number</em></td>
|
||
|
|
<td align="left" valign="top">CHAR(6) A specific job number, or blanks when the
|
||
|
|
job name is the special value of * or *INT.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Size of call message queue name.</strong> The length of the call
|
||
|
|
message queue name parameter, in bytes. The maximum length that can be
|
||
|
|
specified is 256; the minimum length is 1.</p>
|
||
|
|
|
||
|
|
<p><strong>Starting message key.</strong> The message key to be used to begin
|
||
|
|
searching for messages to list from the job. You can use these special values
|
||
|
|
for the message key:</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 the specified key does not exist, messages are listed with the next key
|
||
|
|
that does exist in the search direction specified by the list direction
|
||
|
|
parameter.</p>
|
||
|
|
|
||
|
|
<p>If a key of a reply message is specified, the message search begins with the
|
||
|
|
inquiry or notify message that the reply is associated with, not the reply
|
||
|
|
message itself.</p>
|
||
|
|
|
||
|
|
<p>If the message specified by the starting message key exists but does not
|
||
|
|
meet the selection criteria parameter and the severity criteria parameter
|
||
|
|
specified, no error is returned. The search for messages to list begins from
|
||
|
|
the point that is specified by the starting message key.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRQDS2">Valid Field Identifiers</a></h3>
|
||
|
|
|
||
|
|
<p>For a detailed description of each field, see <a href="#HDRSTFD2">Field
|
||
|
|
Descriptions</a>.</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(*)</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(*)</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(*)</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">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">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">CCSID conversion status indicator for data</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRSTFD2">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Alert option.</strong> Whether and when an SNA alert is created and
|
||
|
|
sent for the message. 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 about 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 that 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 not ask
|
||
|
|
for any message data to be returned or the data did not contain any *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 replacement data is returned in. This only
|
||
|
|
applies to the part of the replacement data that corresponds to a convertible
|
||
|
|
character data type (*CCHAR). All other replacement data will not be converted
|
||
|
|
before it is returned and can be considered to have a CCSID of 65535. 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>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. For more information about the *CCHAR field type, see the
|
||
|
|
<a href="../cl/addmsgd.htm">Add Message Description</a> (ADDMSGD) command.</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 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 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>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>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 used.</strong> The actual name of the library
|
||
|
|
that contains the message file that is used to retrieve the message
|
||
|
|
information. If an immediate message is listed, this field is set to
|
||
|
|
blanks.</p>
|
||
|
|
|
||
|
|
<p><strong>Message help.</strong> The message help for the message listed
|
||
|
|
without formatting characters and without replacement of 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="5 95" -->
|
||
|
|
<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 immediate 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 description of 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 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>Number of the receiving statement numbers or instruction numbers
|
||
|
|
available followed by an array of the receiving statement numbers.</strong> The
|
||
|
|
number of statement numbers or instruction numbers available for the receiving
|
||
|
|
program or procedure.</p>
|
||
|
|
|
||
|
|
<p>For original program model (OPM) programs and nonoptimized procedures, this
|
||
|
|
count is 1.</p>
|
||
|
|
|
||
|
|
<p>For optimized procedures, this count can be greater than 1. In this case,
|
||
|
|
each statement number represents a potential point at which the message could
|
||
|
|
have been received. If the mapping table information has been removed from the
|
||
|
|
program, this field returns a count of 0 and no statement numbers are
|
||
|
|
available. The array of receiving statement numbers or instruction numbers
|
||
|
|
immediately follows this field in the returned data.</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> The number of statement numbers or instruction numbers
|
||
|
|
available for the sending program or procedure.</p>
|
||
|
|
|
||
|
|
<p>For OPM programs and nonoptimized procedures, this count is 1.</p>
|
||
|
|
|
||
|
|
<p>For optimized procedures, this count can be greater than 1. In this case,
|
||
|
|
each statement number represents a potential point at which the message could
|
||
|
|
have been sent. If the mapping table information has been removed from the
|
||
|
|
program, this field returns a count of 0, and no statement numbers are
|
||
|
|
available. The array of sending statement numbers or instruction numbers
|
||
|
|
immediately follows this field in the returned data.</p>
|
||
|
|
|
||
|
|
<p><strong>Problem identification.</strong> This field can be specified for the
|
||
|
|
QGYOLJBL API, but it never returns any data and the length of data field is
|
||
|
|
0.</p>
|
||
|
|
|
||
|
|
<p><strong>Qualified sender job name.</strong> This field can be specified for
|
||
|
|
the QGYOLJBL API, but it never returns any data and the length of data field is
|
||
|
|
0.</p>
|
||
|
|
|
||
|
|
<p><strong>Receiving module name.</strong> The name of the module that contains
|
||
|
|
the procedure where the message was sent. If the message was not sent to a
|
||
|
|
procedure within an Integrated Language Environment (ILE) program, this field
|
||
|
|
is not set and the length of data field is 0.</p>
|
||
|
|
|
||
|
|
<p><strong>Receiving procedure name.</strong> The name of the procedure
|
||
|
|
receiving the message. If the message was not sent to a procedure within an ILE
|
||
|
|
program, this field is not set and the length of data field is 0. A nested
|
||
|
|
procedure name has each procedure name separated by a colon. The outermost
|
||
|
|
procedure name is identified first followed by the procedures it contains. The
|
||
|
|
innermost procedure is identified last in the string.</p>
|
||
|
|
|
||
|
|
<p><strong>Receiving program name.</strong> The program name, or the ILE
|
||
|
|
program name that contains the procedure that the message was sent to.</p>
|
||
|
|
|
||
|
|
<p><strong>Receiving type.</strong> The type of the receiver (whether it is a
|
||
|
|
program or a procedure). Possible values and their meanings follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Receiver is an original program model (OPM)
|
||
|
|
program</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Receiver is a procedure within an ILE program and
|
||
|
|
the procedure name is up to and including 256 characters in length</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">Receiver is a procedure within an ILE program and
|
||
|
|
the procedure name is 257 or more characters in length</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<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 of the
|
||
|
|
following are true:</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> The level of the request-processing program
|
||
|
|
that received the request message. If the message being listed is not a
|
||
|
|
request, this field is set to 0.</p>
|
||
|
|
|
||
|
|
<p><strong>Request status.</strong> Information regarding the processing status
|
||
|
|
of the request message. Possible values and their meanings follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>O</em></td>
|
||
|
|
<td align="left" valign="top">This request message has been received and
|
||
|
|
processed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>C</em></td>
|
||
|
|
<td align="left" valign="top">This request message is currently being
|
||
|
|
processed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>N</em></td>
|
||
|
|
<td align="left" valign="top">This request message has not yet been
|
||
|
|
processed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>If the message being listed is not a request, this field is set to a blank
|
||
|
|
character.</p>
|
||
|
|
|
||
|
|
<p><strong>Sender type.</strong> The type of the sender (whether it is a
|
||
|
|
program or procedure). Possible values and their meanings follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Sender is an OPM or a System Licensed Internal
|
||
|
|
Code (SLIC) program with a name that is 12 characters or less.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Sender is a procedure within an ILE program and
|
||
|
|
the procedure name is up to and including 256 characters in length.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">Sender is a procedure within an ILE program and
|
||
|
|
the procedure name is from 257 characters up to and including 4096 characters
|
||
|
|
in length.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>3</em></td>
|
||
|
|
<td align="left" valign="top">Sender is a SLIC program with a name that is from
|
||
|
|
13 characters up to and including 256 characters in length.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Sending module name.</strong> The name of the module that contains
|
||
|
|
the procedure sending the message. If the message was not sent by a procedure
|
||
|
|
within an ILE program, this field is not set and the length of data field is
|
||
|
|
0.</p>
|
||
|
|
|
||
|
|
<p><strong>Sending procedure name.</strong> The name of the procedure sending
|
||
|
|
the message. If the message was not sent by a procedure within an ILE program,
|
||
|
|
this field is not set and the length of data field is 0. A nested procedure
|
||
|
|
name has each procedure name separated by a colon. The outermost procedure name
|
||
|
|
is identified first followed by the procedures it contains. The innermost
|
||
|
|
procedure is identified last in the string.</p>
|
||
|
|
|
||
|
|
<p><strong>Sending program name.</strong> The sending program name or ILE
|
||
|
|
program name that contains the procedure sending the message.</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>
|
||
|
|
|
||
|
|
<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">CPF1866 E</td>
|
||
|
|
<td width="85%" valign="top">Value &1 for number of fields to return not
|
||
|
|
valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF24B4 E</td>
|
||
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF24B7 E</td>
|
||
|
|
<td valign="top">Value &1 for call stack entry name length not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF240D E</td>
|
||
|
|
<td valign="top">Message search direction specified is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF240F E</td>
|
||
|
|
<td valign="top">Field identifier is not valid or is a duplicate of another
|
||
|
|
field identifier specified.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF2401 E</td>
|
||
|
|
<td valign="top">Not authorized to library &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF2410 E</td>
|
||
|
|
<td valign="top">Message key not found in message queue &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF241E E</td>
|
||
|
|
<td valign="top">Call stack entry name is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF241F E</td>
|
||
|
|
<td valign="top">Length &1 specified for maximum message length is not
|
||
|
|
valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF2441 E</td>
|
||
|
|
<td valign="top">Not authorized to display job log.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF2443 E</td>
|
||
|
|
<td valign="top">Job log not displayed or listed because job has ended.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF252F E</td>
|
||
|
|
<td valign="top">Length &1 specified for maximum message help length is not
|
||
|
|
valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF1 E</td>
|
||
|
|
<td valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C19 E</td>
|
||
|
|
<td valign="top">Error occurred with receiver variable specified.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C21 E</td>
|
||
|
|
<td valign="top">Format name &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C31 E</td>
|
||
|
|
<td valign="top">Object type &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C51 E</td>
|
||
|
|
<td valign="top">Internal job identifier not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C52 E</td>
|
||
|
|
<td valign="top">Internal job identifier no longer valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C53 E</td>
|
||
|
|
<td valign="top">Job &3/&2/&1 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C55 E</td>
|
||
|
|
<td valign="top">Job &3/&2/&1 does not exist.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C58 E</td>
|
||
|
|
<td valign="top">Job name specified is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C59 E</td>
|
||
|
|
<td valign="top">Internal identifier is not blanks and job name is not
|
||
|
|
*INT.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C90 E</td>
|
||
|
|
<td valign="top">Literal value cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF6565 E</td>
|
||
|
|
<td valign="top">User profile storage limit exceeded.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF8100 E</td>
|
||
|
|
<td valign="top">All CPF81xx messages could be returned. xx is from 01 to
|
||
|
|
FF.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9801 E</td>
|
||
|
|
<td valign="top">Object &2 in library &3 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9802 E</td>
|
||
|
|
<td valign="top">Not authorized to object &2 in &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9803 E</td>
|
||
|
|
<td valign="top">Cannot allocate object &2 in library &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9807 E</td>
|
||
|
|
<td valign="top">One or more libraries in library list deleted.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9808 E</td>
|
||
|
|
<td valign="top">Cannot allocate one or more libraries on library list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9811 E</td>
|
||
|
|
<td valign="top">Program &1 in library &2 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9812 E</td>
|
||
|
|
<td valign="top">File &1 in library &2 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9814 E</td>
|
||
|
|
<td valign="top">Device &1 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9821 E</td>
|
||
|
|
<td valign="top">Not authorized to program &1 in library &2.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9822 E</td>
|
||
|
|
<td valign="top">Not authorized to file &1 in library &2.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9825 E</td>
|
||
|
|
<td valign="top">Not authorized to device &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9831 E</td>
|
||
|
|
<td valign="top">Cannot assign device &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9838 E</td>
|
||
|
|
<td valign="top">User profile storage limit exceeded.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">GUI0002 E</td>
|
||
|
|
<td valign="top">&2 is not valid for length of receiver variable.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">GUI0027 E</td>
|
||
|
|
<td valign="top">&1 is not valid for number of records to return.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">GUI0044 E</td>
|
||
|
|
<td valign="top">&1 is not valid for length of message selection
|
||
|
|
information.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V3R6
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|