360 lines
10 KiB
HTML
360 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>Add List Entry (QUIADDLE) 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>Add List Entry (QUIADDLE) 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">Variable buffer</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Variable buffer length</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Variable record name</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">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">6</td>
|
||
|
|
<td align="left" valign="top">Option</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="left" valign="top">List entry handle</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</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 Add List Entry (QUIADDLE) API adds one new entry to a list. The new
|
||
|
|
entry is inserted immediately before or immediately after the entry identified
|
||
|
|
by the current entry pointer for the list. The new entry can also be inserted
|
||
|
|
at the beginning or at the end of the list. On return to the application
|
||
|
|
program, the current entry points to the newly inserted entry.</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> A value assigned by the UIM and returned to the application program by the
|
||
|
|
Open Display Application (QUIOPNDA) API or the Open Print Application
|
||
|
|
(QUIOPNPA) API when the application is opened.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Variable buffer</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p> Program storage containing values of one or more dialog variables, from
|
||
|
|
which dialog variable values are copied. Dialog variables are copied in the
|
||
|
|
order specified in the variable record definition.</p>
|
||
|
|
|
||
|
|
<p> If the variable record name parameter specifies the name of a variable
|
||
|
|
record defined in the panel group for an open application, dialog variables are
|
||
|
|
copied from the variable buffer to the application variable pool before the
|
||
|
|
list entry is added. This parameter operation is the same as using the Put
|
||
|
|
Dialog Variable (QUIPUTV) API immediately before the QUIADDLE API.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Variable buffer length</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p> The length of the variable buffer. The buffer must be large enough to
|
||
|
|
contain all the dialog variables in the variable record definition specified in
|
||
|
|
the variable record name parameter. If the buffer is not large enough, an error
|
||
|
|
condition is reported.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Variable record name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p> The name of the variable record that determines which dialog variables are
|
||
|
|
copied from the variable buffer to the application variable pool. The variable
|
||
|
|
record must be defined in the panel group for the open application. The
|
||
|
|
following special value can be used:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
||
|
|
<td align="left" valign="top">The QUIPUTV API is not used during the QUIADDLE
|
||
|
|
API. The variable buffer parameter and variable buffer length are ignored.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>List name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p> The name of the list to which an entry is added. If the list is not
|
||
|
|
currently active in the open application, it is activated by this API.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Option</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(4)
|
||
|
|
|
||
|
|
<p> The location of the new entry in the list. When an entry is added to the
|
||
|
|
list, the current entry is always changed to point to the new list entry.</p>
|
||
|
|
|
||
|
|
<p> One of the following values must be specified to indicate the new entry's
|
||
|
|
location:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>FRST</em></td>
|
||
|
|
<td align="left" valign="top">Added as the first entry in the list</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>LAST</em></td>
|
||
|
|
<td align="left" valign="top">Added as the last entry in the list</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>NEXT</em></td>
|
||
|
|
<td align="left" valign="top">Added after the current entry</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>PREV</em></td>
|
||
|
|
<td align="left" valign="top">Added before the current entry</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>List entry handle</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(4)
|
||
|
|
|
||
|
|
<p> A value representing an entry in a UIM list and returned to the application
|
||
|
|
program representing the current entry in the list until it is removed from the
|
||
|
|
list, even if other entries are inserted and removed from the list. This value
|
||
|
|
is the handle of the entry just inserted in the list.</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>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">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">CPF6AA1 E</td>
|
||
|
|
<td align="left" valign="top">The value of the action field is not correct at
|
||
|
|
this time. Reason code &5.</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">CPF6A2B E</td>
|
||
|
|
<td align="left" valign="top">Value for Option parameter not valid.</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">CPF6A36 E</td>
|
||
|
|
<td align="left" valign="top">Data not correct for dialog variable &4 in
|
||
|
|
panel group &1 in &2.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A37 E</td>
|
||
|
|
<td align="left" valign="top">Data not correct for dialog variable &4 in
|
||
|
|
panel group &1 in &2.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A38 E</td>
|
||
|
|
<td align="left" valign="top">Variable record &4 not defined in panel
|
||
|
|
group.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A39 E</td>
|
||
|
|
<td align="left" valign="top">Variable buffer length too small.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A9D E</td>
|
||
|
|
<td align="left" valign="top">Size limit reached for list &4.</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">CPF6A93 E</td>
|
||
|
|
<td align="left" valign="top">Operation not valid when current entry is
|
||
|
|
&5.</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>
|
||
|
|
|