ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/xincoml.htm

220 lines
6.4 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>Exit Program for an Incomplete List</title>
<!-- 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. -->
<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>Exit Program for an Incomplete List</h2>
<p>An exit program for handling an incomplete list is defined using the Set
List Attributes (QUISETLA) API. A dialog variable is specified identifying the
program to call.</p>
<p>The dialog variable cannot be blanks or nulls. The UIM cannot process an
incomplete list without the exit program.</p>
<p>This exit allows an application to display part of a list without having to
build the entire list. It must either add more entries or mark the list as
complete in the direction being extended. If the list is not marked complete
and fewer entries than the minimum requested by the UIM are added, the exit
program is called again. If the list is not marked complete and no entries are
added by the exit program, a CPF6A95 error is reported to the program that
called the Display Panel (QUIDSPP), Get List Entry (QUIGETLE), Get List
Multiple Entries (QUIGETLM), or Remove List Entry (QUIRMVLE) API.</p>
<p>The exit program can send messages to the UIM for display on the panel. To
have the messages shown, the exit program must return control to the UIM by
sending a CPF6A05 status or escape message. In this case, any messages sent to
the UIM by the incomplete list exit program are shown when the panel is
displayed. Otherwise, the exit program returns control to the UIM by doing a
normal return.</p>
<p>Sometimes the exit program for an incomplete list is called when no panel is
displayed; such a call occurs when the QUIGETLE, the QUIGETLM, or the QUIRMVLE
API is used. If no panel is displayed when the exit program sends a CPF6A05
status or escape message, any messages sent to the UIM by the exit program are
moved to the program message queue for the program calling that API.</p>
<p>The exit and cancel flags for the job are not reset before the exit program
is called, and the flags are not checked after the exit program returns control
to the UIM. Therefore, the exit and cancel flags should not be turned on by the
exit program.</p>
<br>
<h3>Single Parameter Interface</h3>
<p>QSYSINC Member Name: EUIILEX</p>
<dl>
<dt><strong>Structure level</strong></dt>
<dd>BINARY(4); positions 1-4
<p>The interface level supported by this structure, indicating which fields and
values are available for the current interface level.</p>
</dd>
<dt><strong>Reserved</strong></dt>
<dd>CHAR(8); positions 5-12<br>
<br>
</dd>
<dt><strong>Type of call</strong></dt>
<dd>BINARY(4); positions 13-16
<p>Set to the following value:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Processes an incomplete list exit program.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Application handle</strong></dt>
<dd>CHAR(8); positions 17-24
<p>The application handle of the application currently being processed by the
UIM.</p>
</dd>
<dt><strong>Reserved</strong></dt>
<dd>CHAR(10); positions 25-34<br>
<br>
</dd>
<dt><strong>List name</strong></dt>
<dd>CHAR(10); positions 35-44
<p>The name of the list currently being processed by the UIM.</p>
</dd>
<dt><strong>Incomplete list direction</strong></dt>
<dd>BINARY(4); positions 45-48
<p>The direction from the current list entry in which additional entries must
be added.</p>
<p>Set to one of the following values:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">More list entries are required after the current
list entry.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">More list entries are required before the current
list entry.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Number of entries required</strong></dt>
<dd>BINARY(4); positions 49-52
<p>The minimum number of entries that must be added to the list.</p>
</dd>
</dl>
<br>
<h3>Multiple Parameter Interface</h3>
<p>The description of parameters listed in the following table is the same as
the corresponding field in the structure for a single parameter interface. The
positions listed for each field in the structure do not apply to the multiple
parameter interface.</p>
<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;Parameters for interface level 1:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Type of call</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Application handle</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">3</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">4</td>
<td align="left" valign="top">Incomplete list direction</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">Number of entries required</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;No additional parameters are required for interface level 2.<br>
<!-- iddvc RMBR -->
<br>
</div>
<br>
<hr>
Exit program 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>