446 lines
14 KiB
HTML
446 lines
14 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>Set List Attributes (QUISETLA) 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>Set List Attributes (QUISETLA) 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">List contents</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">Program dialog variable</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">Display position attribute</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</td>
|
||
|
|
<td align="left" valign="top">Allow trim attribute</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(1)</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 Set List Attributes (QUISETLA) API sets the following list
|
||
|
|
attributes:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The list contents attribute, which indicates 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 the UIM calls
|
||
|
|
when additional entries are needed in an incomplete list</li>
|
||
|
|
|
||
|
|
<li>The display position attribute, which is the list entry handle for the
|
||
|
|
entry presented at the top row of a list area displaying the list</li>
|
||
|
|
|
||
|
|
<li>An attribute indicating whether or not the UIM trims the list if the
|
||
|
|
maximum list size is exceeded when adding a new entry to the list</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>If the QUISETLA API has not been called for a list since the first entry was
|
||
|
|
inserted, the list contents default value is ALL and the list is complete. An
|
||
|
|
error message is displayed if the user attempts to page beyond either end of
|
||
|
|
the list. The UIM does not call a program for more entries or return to the
|
||
|
|
program that called the Display Panel (QUIDSPP) API.<br>
|
||
|
|
</p>
|
||
|
|
<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 changed. If the list is not
|
||
|
|
currently active in the open application, it is activated by this API.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>List contents</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(4)
|
||
|
|
|
||
|
|
<p> Indicates whether or not the list contains all or some of the entries
|
||
|
|
available. One of the following values must be specified:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>SAME</em></td>
|
||
|
|
<td align="left" valign="top">This list contents attribute of the list is not
|
||
|
|
changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>ALL</em></td>
|
||
|
|
<td align="left" valign="top">The entire list has been built. A message is
|
||
|
|
displayed if the user attempts to page beyond the top or the bottom of the
|
||
|
|
list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>TOP</em></td>
|
||
|
|
<td align="left" valign="top">Only the top part of the list is built. A message
|
||
|
|
is displayed if the user attempts to page beyond the beginning of the list. If
|
||
|
|
the user attempts to page beyond the bottom of the list, the program specified
|
||
|
|
by the program dialog variable parameter is called by the UIM, with parameters
|
||
|
|
indicating the need for more entries at the bottom of the list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>BOT</em></td>
|
||
|
|
<td align="left" valign="top">Only the bottom part of the list is built. A
|
||
|
|
message is displayed if the user attempts to page beyond the bottom of the
|
||
|
|
list. If the user attempts to page beyond the top of the list, the program
|
||
|
|
specified by the program dialog variable parameter is called by the UIM, with
|
||
|
|
parameters indicating the need for more entries at the top of the list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>MORE</em></td>
|
||
|
|
<td align="left" valign="top">Only the middle of the list is built. If the user
|
||
|
|
attempts to page beyond either the top or the bottom the list, the program
|
||
|
|
specified by the program dialog variable parameter is called by the UIM, with
|
||
|
|
parameters indicating the need for more entries at the top or bottom of the
|
||
|
|
list.
|
||
|
|
|
||
|
|
<p> If the application program marks the list complete in a given direction,
|
||
|
|
the application program cannot subsequently mark the list incomplete in that
|
||
|
|
same direction.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Program dialog variable</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The name of a dialog variable in an open application. This dialog variable
|
||
|
|
contains information identifying the program called by the UIM when more
|
||
|
|
entries must be added to an incomplete list. The dialog variable must be
|
||
|
|
defined and set properly according to the rules used for the CALL dialog
|
||
|
|
command.</p>
|
||
|
|
|
||
|
|
<p>For a description of the CALL dialog command, see the <a href=
|
||
|
|
"../books/sc415715.pdf" target="_blank">Application Display Programming</a>
|
||
|
|
<img src="wbpdf.gif" alt="Link to PDF"> book. For a description of the
|
||
|
|
interface between the UIM and the incomplete list exit program, see <a href=
|
||
|
|
"uim1c.htm">Using the User Interface Manager exit programs</a>.</p>
|
||
|
|
|
||
|
|
<p> The following special value can be used:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*SAME</em></td>
|
||
|
|
<td align="left" valign="top">The program dialog variable is not changed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Display position attribute</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(4)
|
||
|
|
|
||
|
|
<p> The list entry that should be positioned at the top of the list area on the
|
||
|
|
next panel that displays this list. The UIM does not use the display position
|
||
|
|
attribute when printing the list.</p>
|
||
|
|
|
||
|
|
<p> The value specified must be the list entry handle currently existing in the
|
||
|
|
list or one of the following special values:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>SAME</em></td>
|
||
|
|
<td align="left" valign="top">The display position attribute of the list is not
|
||
|
|
changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>TOP</em></td>
|
||
|
|
<td align="left" valign="top">The entries at the top of the list should be
|
||
|
|
positioned at the top of the list area on the next panel.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>BOT</em></td>
|
||
|
|
<td align="left" valign="top">The bottom <em>n</em> entries of the list should
|
||
|
|
be displayed in the list area on the next panel, where <em>n</em> is the number
|
||
|
|
of list entries that can be displayed in the current view of the list. If the
|
||
|
|
list contains fewer than <em>n</em> list entries, the complete list is
|
||
|
|
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 automatically adjusts
|
||
|
|
the attribute to display the entry before the one removed. If there is no
|
||
|
|
previous entry in the list, the attribute is set at the top of the list, and
|
||
|
|
the next panel displaying the list shows the first entry in the list.</p>
|
||
|
|
|
||
|
|
<p> During incomplete list extension, the application program must specify SAME
|
||
|
|
for the display position attribute.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Allow trim attribute</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(1)
|
||
|
|
|
||
|
|
<p> Indicates whether or not the UIM should trim the list during the Add List
|
||
|
|
Entry (QUIADDLE) or the Add List Multiple Entries (QUIADDLM) API if adding the
|
||
|
|
new entry exceeds the maximum list size. The UIM trims only lists that have
|
||
|
|
been marked as incomplete by using the QUISETLA API. When the UIM removes the
|
||
|
|
list entry, the UIM marks the list incomplete in the direction from which the
|
||
|
|
entry was removed, regardless of whether or not the list was previously
|
||
|
|
incomplete in this direction.</p>
|
||
|
|
|
||
|
|
<p> If an application is adding an entry to the bottom of the list when the
|
||
|
|
maximum size list is reached, the UIM removes the first list entry and marks
|
||
|
|
the list incomplete at the top. The incomplete list exit program of the
|
||
|
|
application must be prepared to add list entries in either direction of an
|
||
|
|
incomplete list.</p>
|
||
|
|
|
||
|
|
<p> When the incomplete list exit program is called to add list entries, the
|
||
|
|
QUIADDLE or QUIADDLM API can be called to add entries in the middle of the
|
||
|
|
list. If the entries are added to the middle of the list when the list is
|
||
|
|
complete; trimming does not take place and an error is reported indicating that
|
||
|
|
the maximum list size has been reached.</p>
|
||
|
|
|
||
|
|
<p> One of the following values must be specified:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>S</em></td>
|
||
|
|
<td align="left" valign="top">The allow trim attribute of the list should not
|
||
|
|
be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<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>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 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">CPF6AA0 E</td>
|
||
|
|
<td align="left" valign="top">Request is not allowed when extending a list that
|
||
|
|
is not complete.</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">CPF6A9A E</td>
|
||
|
|
<td align="left" valign="top">Dialog variable required to specify incomplete
|
||
|
|
list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A9B E</td>
|
||
|
|
<td align="left" valign="top">Dialog variable &5 not the correct type.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A9C E</td>
|
||
|
|
<td align="left" valign="top">List entry handle not correct.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A9E E</td>
|
||
|
|
<td align="left" valign="top">Value for Allow Trim parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A9F E</td>
|
||
|
|
<td align="left" valign="top">Attribute for list &4 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A90 E</td>
|
||
|
|
<td align="left" valign="top">Value not correct. Reason code &3.</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">CPF6A99 E</td>
|
||
|
|
<td align="left" valign="top">Dialog variable &5 not found in panel group
|
||
|
|
&1 in &2.</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>
|
||
|
|
|