362 lines
10 KiB
HTML
362 lines
10 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>Get List Entries (QGYGTLE) 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. -->
|
|
<!-- QEARMVBM SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
|
|
<!-- at RCHVMW2 on 6 Oct 1998 at 19:53:10 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- File cleanup completed on 9 July 2001 -->
|
|
<!-- 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<h2>Get List Entries (QGYGTLE) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<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">Request handle</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</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">5</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">6</td>
|
|
<td align="left" valign="top">Starting record</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 Get List Entries (QGYGTLE) API allows requests to get entries from
|
|
previously opened lists on the iSeries server. A list will exist if an initial
|
|
request has already been made and the list was not closed using the Close List
|
|
(QGYCLST) API.</p>
|
|
|
|
<p>Initial requests are made by calling the following APIs:</p>
|
|
|
|
<ul>
|
|
<li>Open List of Job Log Messages (QGYOLJBL)</li>
|
|
|
|
<li>Open List of Messages (QGYOLMSG)</li>
|
|
|
|
<li>Open List of Objects (QGYOLOBJ)</li>
|
|
|
|
<li>Open List of Printers (QGYRPRTL)</li>
|
|
|
|
<li>Open List of Spooled Files (QGYOLSPL)</li>
|
|
|
|
<li>Open List of User Certificates (QSYOLUC)</li>
|
|
|
|
<li>Open List of Validation List Entries (QSYOLVLE)</li>
|
|
|
|
<li>Retrieve Objects Secured by Authorization List (QGYRATLO)</li>
|
|
</ul>
|
|
|
|
<br>
|
|
|
|
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The receiver variable that receives the information requested. You can
|
|
specify the size of the area to be smaller than the format requested as long as
|
|
you specify the length parameter correctly. As a result, the API returns only
|
|
the data that the area can hold.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable provided. The length of receiver
|
|
variable parameter may be specified up to the size of the receiver variable
|
|
specified in the user program. If the length of receiver variable parameter
|
|
specified is larger than the allocated size of the receiver variable specified
|
|
in the user program, the results are not predictable. The minimum length is 8
|
|
bytes.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Request handle</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(4)
|
|
|
|
<p>The handle of the request. The value of this determines from which user
|
|
space to retrieve the information.</p>
|
|
</dd>
|
|
|
|
<dt><strong>List information</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(80)
|
|
|
|
<p>Information about the list from which entries are being returned. For a
|
|
description of the layout 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 (starting with the record indicated in the
|
|
starting record parameter) to take from the user space and put into the
|
|
receiver variable. This value must be greater than or equal to zero.</p>
|
|
|
|
<p>If the value zero is specified, then only the list information is returned
|
|
and no actual list entries are returned.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Starting record</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The entry in the list that will be the first entry to be put into the
|
|
receiver variable. The value must be greater than zero or one of the special
|
|
values of 0 or -1.</p>
|
|
|
|
<p>The special value of 0 indicates that the list information should be
|
|
returned to the caller immediately. The special value 0 is only allowed when
|
|
the number of records to return parameter is zero.</p>
|
|
|
|
<p>The special value of -1 indicates that the whole list should be built before
|
|
the list information is returned to the caller.</p>
|
|
|
|
<p>The following table shows how the number of records to return and the
|
|
starting record parameters interact with each other. The record parameter is
|
|
represented by an X. The number of records to return parameter is represented
|
|
by a Y.</p>
|
|
|
|
<table border cellpadding="5">
|
|
<tr>
|
|
<th align="left" valign="bottom">Starting Record (X)</th>
|
|
<th align="left" valign="bottom">Number of records to return (Y=0)</th>
|
|
<th align="left" valign="bottom">Number of records to return (Y>0)</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">X = 0</td>
|
|
<td align="left" valign="top">Immediately return only the list information</td>
|
|
<td align="left" valign="top">Invalid combination. An error message is
|
|
sent.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">X = -1</td>
|
|
<td align="left" valign="top">Return only the list information, but wait until
|
|
the whole list is built</td>
|
|
<td align="left" valign="top">Wait until the whole list is built and then
|
|
return the number of records requested from the end of the list. See note.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="3"><strong>Note:</strong> If the
|
|
receiver variable is not large enough to hold the number of records requested,
|
|
then only those that will fit into the receiver variable will be returned, but
|
|
they will always be the last ones in the list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">X > 0</td>
|
|
<td align="left" valign="top">Return only the list information, but wait until
|
|
list entries have been built, as specified in the starting record
|
|
parameter.</td>
|
|
<td align="left" valign="top">Return the number of list entries specified in
|
|
the number of records to return parameter starting with the entry specified in
|
|
the starting record parameter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dd><br>
|
|
</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 Receiver Variable</h3>
|
|
|
|
<p>The format of the receiver variable was specified when the list was
|
|
originally created.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</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">CPF3C19 E</td>
|
|
<td align="left" valign="top">Error occurred with receiver variable
|
|
specified.</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">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter not valid.</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>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">GUI0001 E</td>
|
|
<td align="left" valign="top">Invalid handle specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">GUI0002 E</td>
|
|
<td align="left" valign="top">&2 is not valid for length of receiver
|
|
variable.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">GUI0006 E</td>
|
|
<td align="left" valign="top">&1 is not valid for starting record
|
|
number.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">GUI0027 E</td>
|
|
<td align="left" valign="top">&1 is not valid for number of records to
|
|
return.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">GUI0114 E</td>
|
|
<td align="left" valign="top">The list cannot be completed. No server jobs are
|
|
running or can be started.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">GUI0115 E</td>
|
|
<td align="left" valign="top">The list has been marked in error. See the
|
|
previous messages.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">GUI0118 E</td>
|
|
<td align="left" valign="top">Starting record cannot be 0 when records have
|
|
been requested.</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="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|