290 lines
8.5 KiB
HTML
290 lines
8.5 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>Remove List Entry (QUIRMVLE) 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>Remove List Entry (QUIRMVLE) 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">Extend option</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</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">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 Remove List Entry (QUIRMVLE) API removes the list entry identified by
|
|
the value of the current entry pointer for the list. The current entry pointer
|
|
is always updated to the entry before the one removed. If the first list entry
|
|
is removed, the current entry pointer is set to the top of the list if the list
|
|
is complete at the top.</p>
|
|
|
|
<p>If the list is incomplete at the top, the UIM calls the incomplete list
|
|
extension program to add another entry to the list.</p>
|
|
|
|
<p>If the list entry identified by the display position attribute parameter of
|
|
the Set List Attributes (QUISETLA) API is removed, the display position
|
|
attribute is set at the entry before the one that was removed. If the new
|
|
display position attribute is the first entry in the list, the display position
|
|
attribute is set at the top of the list (logically the entry before the first
|
|
entry in the list) if the list is complete at the top.</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>List name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p> The name of the list from which an entry is removed. If the list is not
|
|
currently active in the open application, an error message is reported. A list
|
|
is made active the first time an entry is inserted with the Add List Entry
|
|
(QUIADDLE) API, Add List Multiple Entries (QUIADDLM) API, or its attributes are
|
|
set with the QUISETLA API.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Extend option</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p> Specifies whether or not an incomplete list is automatically extended in an
|
|
attempt to remove the first entry from a list that is incomplete at the top.
|
|
One of the following values must be specified:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>Y</em></td>
|
|
<td align="left" valign="top">The list is extended, if necessary, to add at
|
|
least one entry to the top of the list or to mark the list as complete at the
|
|
top.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>N</em></td>
|
|
<td align="left" valign="top">The list is not extended to find the entry before
|
|
the entry being removed, and the entry is not removed from the list.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>List entry handle</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(4)
|
|
|
|
<p> The list entry handle value from the current entry pointer. 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. A value of TOP
|
|
indicates that the current entry pointer is positioned at the top of 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>
|
|
|
|
<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">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">CPF6A13 E</td>
|
|
<td align="left" valign="top">Application &3 closed prematurely.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A14 E</td>
|
|
<td align="left" valign="top">Program defined by variable &4 cannot be
|
|
called.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A15 E</td>
|
|
<td align="left" valign="top">Errors occurred in list exit program.</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">CPF6A27 E</td>
|
|
<td align="left" valign="top">Value for Extend Option parameter 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">CPF6A93 E</td>
|
|
<td align="left" valign="top">Operation not valid when current entry is
|
|
&5.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A94 E</td>
|
|
<td align="left" valign="top">Incomplete list &4 requires extension.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A95 E</td>
|
|
<td align="left" valign="top">List &4 either not complete or not
|
|
extended.</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>
|
|
|