335 lines
10 KiB
HTML
335 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>Retrieve List Attributes (QUIRTVLA) 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. -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!--Edited by Kersten Nov 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>Retrieve List Attributes (QUIRTVLA) 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%">Application handle</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">List name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Receiver</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Receiver length</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">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 Retrieve List Attributes (QUIRTVLA) API retrieves the following list
|
||
|
|
attributes:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The list contents attribute, indicating whether or not all entries are
|
||
|
|
present in the list, and which entries are missing if it is incomplete</li>
|
||
|
|
|
||
|
|
<li>The name of the dialog variable that identifies the program called when the
|
||
|
|
UIM needs to add entries to an incomplete list</li>
|
||
|
|
|
||
|
|
<li>The display position attribute, which is the list entry handle for the
|
||
|
|
entry presented at the top-most row of any list area that displays a list</li>
|
||
|
|
|
||
|
|
<li>The allow trim attribute, which indicates whether or not the UIM trims a
|
||
|
|
full list when adding new entries</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>Application handle</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p> The application handle assigned by the UIM and returned to the application
|
||
|
|
program by the Open Display Application (QUIOPNDA) API or by the Open Print
|
||
|
|
Application (QUIOPNPA) API when the application is opened.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>List name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p> The name of the list whose attributes are retrieved. If the list is not
|
||
|
|
currently active in the open application, an error is reported. A list is made
|
||
|
|
active the first time an entry is inserted with the Add List Entry (QUIADDLE)
|
||
|
|
or Add List Multiple Entries (QUIADDLM) API, or the fist time the list's
|
||
|
|
attributes are set with the Set List Attributes (QUISETLA) API.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Receiver</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p> The current attributes of the list. For the format of the receiver
|
||
|
|
variable, see <a href="#HDRFMTDAT">Format of Data Returned</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Receiver length</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p> The amount of data the application program is prepared to receive. If the
|
||
|
|
length specified is larger than the amount of data available, the receiver is
|
||
|
|
not changed beyond the amount of data available.</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>
|
||
|
|
|
||
|
|
<h3><a name="HDRFMTDAT">Format of Data Returned</a></h3>
|
||
|
|
|
||
|
|
<p>The format of the data available, returned in the receiver parameter, is as
|
||
|
|
follows:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" nowrap><em>CHAR(4)</em></td>
|
||
|
|
<td align="left" valign="top">The list contents attribute, indicating whether
|
||
|
|
or not the list contains all or some of the entries available for display or
|
||
|
|
printing. For more information about the meaning of each possible return value,
|
||
|
|
see the <a href="quisetla.htm">Set List Attributes (QUISETLA) API</a>. The
|
||
|
|
following values can be returned in this parameter:
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>ALL</em></td>
|
||
|
|
<td align="left" valign="top">The list is complete. This value is returned when
|
||
|
|
either the QUISETLA API has not been called to set the list attribute or when
|
||
|
|
ALL is the last list contents attribute specified on a call to the QUISETLA API
|
||
|
|
for the list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>TOP</em></td>
|
||
|
|
<td align="left" valign="top">Only the top part of an incomplete list is
|
||
|
|
available. This value is returned when TOP is the last list contents attribute
|
||
|
|
specified on a call to the QUISETLA API for the list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>BOT</em></td>
|
||
|
|
<td align="left" valign="top">Only the bottom part of an incomplete list is
|
||
|
|
available. This value is returned when BOT is the last list contents attribute
|
||
|
|
specified on a call to the QUISETLA API for the list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>MORE</em></td>
|
||
|
|
<td align="left" valign="top">Only the middle part of an incomplete list is
|
||
|
|
available. This value is returned when MORE is the last list contents attribute
|
||
|
|
specified on a call to the QUISETLA API for the list.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" nowrap><em>CHAR(10)</em></td>
|
||
|
|
<td align="left" valign="top">The name of the dialog variable identifying the
|
||
|
|
program the UIM calls when more entries are needed in an incomplete list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>CHAR(4)</em></td>
|
||
|
|
<td align="left" valign="top">The display position attribute, which is the list
|
||
|
|
entry handle at the top of the list area on the next panel that displays this
|
||
|
|
list. The UIM does not use the display position attribute for print
|
||
|
|
applications.
|
||
|
|
|
||
|
|
<p>The value returned is the handle for a specific entry in the list, or one of
|
||
|
|
the following special values:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>TOP</em></td>
|
||
|
|
<td align="left" valign="top">The top entries in the list are displayed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>BOT</em></td>
|
||
|
|
<td align="left" valign="top">The bottom entries in the list are
|
||
|
|
displayed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>If the list entry identified by the display position attribute of a list is
|
||
|
|
removed before the list is displayed on a panel, the UIM adjusts the attribute
|
||
|
|
to display the entry before the one that was removed. The value returned by
|
||
|
|
this API is not meaningful if entries are removed from the list after the
|
||
|
|
display position attribute is retrieved.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>CHAR(1)</em></td>
|
||
|
|
<td align="left" valign="top">The allow trim attribute, which indicates whether
|
||
|
|
or not the UIM trims the list when a new list entry causes the list to exceed
|
||
|
|
its maximum size. For additional details, see the <a href="quisetla.htm">Set
|
||
|
|
List Attributes (QUISETLA) API</a>.
|
||
|
|
|
||
|
|
<p>One of the following values is returned:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>Y</em></td>
|
||
|
|
<td align="left" valign="top">The UIM automatically trims the list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>N</em></td>
|
||
|
|
<td align="left" valign="top">The UIM does not automatically trim the
|
||
|
|
list.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<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">CPF3C90 E</td>
|
||
|
|
<td width="85%" valign="top">Literal value cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A0B E</td>
|
||
|
|
<td align="left" valign="top">Application handle &3 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A0C E</td>
|
||
|
|
<td align="left" valign="top">Application domain error for application
|
||
|
|
&1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A0F E</td>
|
||
|
|
<td align="left" valign="top">Previous error occurred while running application
|
||
|
|
&3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A24 E</td>
|
||
|
|
<td align="left" valign="top">Parameter &1 not passed correctly.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A25 E</td>
|
||
|
|
<td align="left" valign="top">Return code length of &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A91 E</td>
|
||
|
|
<td align="left" valign="top">List &4 does not exist.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A92 E</td>
|
||
|
|
<td align="left" valign="top">List &4 not active.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9872 E</td>
|
||
|
|
<td align="left" valign="top">Program or service program &1 in library
|
||
|
|
&2 ended. Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V2R2
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<table cellpadding="2" cellspacing="2" align="center">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"uim1.htm">User Interface Manager (UIM) APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|