242 lines
12 KiB
HTML
242 lines
12 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="reference" />
|
||
|
|
<meta name="DC.Title" content="Open list information format" />
|
||
|
|
<meta name="abstract" content="The format of the open list information is common across many of the open list APIs." />
|
||
|
|
<meta name="description" content="The format of the open list information is common across many of the open list APIs." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="concept.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/misc1b.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="oli" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- 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. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>Open list information format</title>
|
||
|
|
</head>
|
||
|
|
<body id="oli"><a name="oli"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">Open list information format</h1>
|
||
|
|
<div><p>The format of the open list information is common across many of
|
||
|
|
the open list APIs.</p>
|
||
|
|
<div class="section"><p>This common open list structure provides information necessary
|
||
|
|
to the API caller in order to properly process the list. If the API error
|
||
|
|
code parameter indicates that no error occurred then the Information complete
|
||
|
|
indicator should be checked for a value of either 'C' (complete and accurate)
|
||
|
|
or 'P' (partial and accurate). If one of these values is found then the caller
|
||
|
|
should process the number of entries indicated by Records returned.</p>
|
||
|
|
<p>When
|
||
|
|
these records have been processed the API caller should then determine if
|
||
|
|
all records that could be returned in the list have been returned. This is
|
||
|
|
accomplished by comparing Total records to the sum of First record in receiver
|
||
|
|
variable and Records returned less 1. When Total records is greater than
|
||
|
|
or equal to First record in receiver variable + Records returned -1 then additional
|
||
|
|
calls to QGYGTLE may continue to receive new records if List status indicator
|
||
|
|
is not '3' or '5'. When Total records have been processed and List status
|
||
|
|
is '2' or '5', or if the caller no longer needs to process the list, a call
|
||
|
|
to QGYCLST should be done.</p>
|
||
|
|
<p>The open list APIs return data for use by
|
||
|
|
the process open list APIs. The process open list APIs are located in the
|
||
|
|
Process Open List category, whereas the open list APIs can be found in the
|
||
|
|
applicable sections. For example, the Open List of Messages (QGYOLMSG) API
|
||
|
|
is located in the Message Handling part.</p>
|
||
|
|
<p>The following shows the format
|
||
|
|
of the list information parameter in the open list APIs. For a detailed description
|
||
|
|
of each field, see <a href="#oli__HDRLISTFI">Field descriptions</a>.</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e35">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e37">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e39">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e42">Dec</th>
|
||
|
|
<th valign="top" id="d0e44">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e35 d0e42 ">0</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">0</td>
|
||
|
|
<td valign="top" headers="d0e37 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">Total records</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e35 d0e42 ">4</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">4</td>
|
||
|
|
<td valign="top" headers="d0e37 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">Records returned</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e35 d0e42 ">8</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">8</td>
|
||
|
|
<td valign="top" headers="d0e37 ">CHAR(4)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">Request handle</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e35 d0e42 ">12</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">C</td>
|
||
|
|
<td valign="top" headers="d0e37 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">Record length</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e35 d0e42 ">16</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">10</td>
|
||
|
|
<td valign="top" headers="d0e37 ">CHAR(1)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">Information complete indicator</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e35 d0e42 ">17</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">11</td>
|
||
|
|
<td valign="top" headers="d0e37 ">CHAR(13)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">Date and time created</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e35 d0e42 ">30</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">1E</td>
|
||
|
|
<td valign="top" headers="d0e37 ">CHAR(1)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">List status indicator</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e35 d0e42 ">31</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">1F</td>
|
||
|
|
<td valign="top" headers="d0e37 ">CHAR(1)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e35 d0e42 ">32</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">20</td>
|
||
|
|
<td valign="top" headers="d0e37 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">Length of information returned</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e35 d0e42 ">36</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">24</td>
|
||
|
|
<td valign="top" headers="d0e37 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">First record in receiver variable</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e35 d0e42 ">40</td>
|
||
|
|
<td valign="top" headers="d0e35 d0e44 ">28</td>
|
||
|
|
<td valign="top" headers="d0e37 ">CHAR(40)</td>
|
||
|
|
<td valign="top" headers="d0e39 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="oli__HDRLISTFI"><a name="oli__HDRLISTFI"><!-- --></a><h4 class="sectiontitle">Field descriptions</h4><p><span class="uicontrol">Date
|
||
|
|
and time created.</span> The date and time when the list was created.
|
||
|
|
The 13 characters are:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e159">Character</th>
|
||
|
|
<th valign="bottom" id="d0e161">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e159 "><em>1</em></td>
|
||
|
|
<td valign="top" headers="d0e161 ">Century, where 0 indicates years 19 <em>xx</em> and 1 indicates years
|
||
|
|
20 <em>xx</em>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e159 "><em>2-7</em></td>
|
||
|
|
<td valign="top" headers="d0e161 ">The date, in YYMMDD (year, month, day) format.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e159 "><em>8-13</em></td>
|
||
|
|
<td valign="top" headers="d0e161 ">The time of day, in HHMMSS (hours, minutes, seconds) format.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p><span class="uicontrol">First record in receiver variable.</span> The
|
||
|
|
number of the first record returned in the receiver variable.</p>
|
||
|
|
<p><span class="uicontrol">Information
|
||
|
|
complete indicator.</span> Whether all requested information has been
|
||
|
|
supplied. Possible values follow:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e202">Value</th>
|
||
|
|
<th valign="bottom" id="d0e204">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e202 "><em>C</em></td>
|
||
|
|
<td valign="top" headers="d0e204 ">Complete and accurate information. All of the requested records have
|
||
|
|
been returned in the receiver variable.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e202 "><em>I</em></td>
|
||
|
|
<td valign="top" headers="d0e204 ">Incomplete information. An interruption causes the receiver variable
|
||
|
|
to contain incomplete information.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e202 "><em>P</em></td>
|
||
|
|
<td valign="top" headers="d0e204 ">Partial and accurate information. Partial information is returned when
|
||
|
|
the receiver variable is full and not all of the records requested are returned.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p><span class="uicontrol">Length of information returned.</span> The size,
|
||
|
|
in bytes, of the information that is returned in the receiver variable.</p>
|
||
|
|
<p><span class="uicontrol">List
|
||
|
|
status indicator.</span> The status of building the list. Possible values
|
||
|
|
follow:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e239">Value</th>
|
||
|
|
<th valign="bottom" id="d0e241">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e239 "><em>0</em></td>
|
||
|
|
<td valign="top" headers="d0e241 ">The building of the list is pending.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e239 "><em>1</em></td>
|
||
|
|
<td valign="top" headers="d0e241 ">The list is in the process of being built.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e239 "><em>2</em></td>
|
||
|
|
<td valign="top" headers="d0e241 ">The list has been completely built.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e239 "><em>3</em></td>
|
||
|
|
<td valign="top" headers="d0e241 ">An error occurred when building the list. The next call to the Get
|
||
|
|
List Entries (QGYGTLE) API will cause the error to be signaled to the caller
|
||
|
|
of the QGYGTLE API.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e239 "><em>4</em></td>
|
||
|
|
<td valign="top" headers="d0e241 ">The list is primed and ready to be built. The list will be built asynchronously
|
||
|
|
by a server job, but the server job has not necessarily started building the
|
||
|
|
list yet.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e239 "><em>5</em></td>
|
||
|
|
<td valign="top" headers="d0e241 ">Given the current selection criteria and information requested, there
|
||
|
|
is too much data to be returned. The list is incomplete, but data collected
|
||
|
|
to this point is available.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p><span class="uicontrol">Record length.</span> The length of each record
|
||
|
|
of information returned. For variable length records, this value is set to
|
||
|
|
zero. For variable length records, you can obtain the length of individual
|
||
|
|
records from the records themselves.</p>
|
||
|
|
<p><span class="uicontrol">Records returned.</span>
|
||
|
|
The number of records that are returned in the receiver variable. This number
|
||
|
|
is the smallest of the following values:</p>
|
||
|
|
<ul><li>The number of records that will fit into the receiver variable.</li>
|
||
|
|
<li>The number of records in the list.</li>
|
||
|
|
<li>The number of records that are requested.</li>
|
||
|
|
</ul>
|
||
|
|
<p><span class="uicontrol">Request handle.</span> The handle of the request
|
||
|
|
that can be used for subsequent requests of information from the list. The
|
||
|
|
handle is valid until the Close List (QGYCLST) API is called to close the
|
||
|
|
list, or until the job ends.</p>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> This field should be treated as a hexadecimal
|
||
|
|
field. It should not be converted from one CCSID to another, for example,
|
||
|
|
EBCDIC to ASCII, because doing so could result in an unusable value.</div>
|
||
|
|
<p><span class="uicontrol">Reserved.</span>
|
||
|
|
An ignored field.</p>
|
||
|
|
<p><span class="uicontrol">Total records.</span> The total number
|
||
|
|
of records available in the list.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="concept.htm" title="Describes the underlying concepts that you need to understand to work effectively with APIs. Among the concepts covered are basic concepts, programming considerations, and terminology.">API concepts</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="relref"><strong>Related reference</strong><br />
|
||
|
|
<div><a href="../apis/misc1b.htm">Process Open List APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|