349 lines
10 KiB
HTML
349 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>Update List Entry (QUIUPDLE) 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>Update List Entry (QUIUPDLE) 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 Update List Entry (QUIUPDLE) API updates the list entry identified by
|
||
|
|
the current entry pointer for the list or the extended action entry. The
|
||
|
|
current contents of all dialog variables corresponding to dialog variables in
|
||
|
|
the list are saved in the entry. The current entry pointer of the list is not
|
||
|
|
changed by this operation.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and -->
|
||
|
|
<!-- 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 the Open Print
|
||
|
|
Application (QUIOPNPA) API when the application is opened.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Variable buffer</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p> The program buffer from which dialog variable values are copied. The 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, which is defined in the panel group for this open application, dialog
|
||
|
|
variables are copied from the variable buffer to the application variable pool
|
||
|
|
before the list entry is updated. The operation of this parameter is the same
|
||
|
|
as using the Put Dialog Variable (QUIPUTV) API immediately before the QUIUPDLE
|
||
|
|
API.</p>
|
||
|
|
|
||
|
|
<p> The variable buffer must be large enough to contain all the variables
|
||
|
|
specified in the variable record definition.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Variable buffer length</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p> The length of the variable buffer provided. The buffer must be large enough
|
||
|
|
to contain all the dialog variables in the definition of the variable record,
|
||
|
|
specified in the variable record name parameter.</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 between the variable buffer and the application variable pool. The
|
||
|
|
variable record must be defined in the panel group for the open
|
||
|
|
application.</p>
|
||
|
|
|
||
|
|
<p> 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 done during the QUIUPDLE
|
||
|
|
API. The variable buffer parameter is ignored when this value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>List name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p> The name of the list in which an entry is updated. 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)
|
||
|
|
API or the Add List Multiple Entries (QUIADDLM) API, or its attributes are set
|
||
|
|
with the Set List Attributes (QUISETLA) API.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Option</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(4)
|
||
|
|
|
||
|
|
<p> The updated list entry. One of the following values must be specified:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EXTE</em></td>
|
||
|
|
<td align="left" valign="top">The extended action entry is updated.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>SAME</em></td>
|
||
|
|
<td align="left" valign="top">The list entry identified by the current entry
|
||
|
|
pointer is updated.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>List entry handle</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(4)
|
||
|
|
|
||
|
|
<p> The list entry handle for the updated list entry. A list entry handle
|
||
|
|
uniquely distinguishes an entry until it is removed from the list, even if
|
||
|
|
other entries are inserted and removed from the list.</p>
|
||
|
|
|
||
|
|
<p> When the option parameter has the value EXTE, this parameter returns the
|
||
|
|
value EXTE, indicating that the extended action entry is updated.</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">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">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">CPF6A28 E</td>
|
||
|
|
<td align="left" valign="top">Value for Option parameter 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">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">CPF6A92 E</td>
|
||
|
|
<td align="left" valign="top">List &4 not active.</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>
|
||
|
|
|