414 lines
11 KiB
HTML
414 lines
11 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 Action List Option or Pull-Down Field Choice</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 Action List Option or Pull-Down Field Choice</h2>
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<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%">Structure level</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">Reserved</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">Type of call</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">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">5</td>
|
||
|
|
<td align="left" valign="top">Panel 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">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">7</td>
|
||
|
|
<td align="left" valign="top">List entry handle</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">Option number</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">9</td>
|
||
|
|
<td align="left" valign="top">Function qualifier</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">10</td>
|
||
|
|
<td align="left" valign="top">Action results</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">11</td>
|
||
|
|
<td align="left" valign="top">Pull-down field name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
QSYSINC Member Name: EUIALEX<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>An exit program can be specified for an action list option using the USREXIT
|
||
|
|
attribute of the list action (LISTACT) tag. The exit program is called
|
||
|
|
immediately after the action specified on the ENTER, PROMPT, EXTENTER, or
|
||
|
|
EXTPROMPT attribute of the LISTACT tag is processed.</p>
|
||
|
|
|
||
|
|
<p>An exit program for a pull-down field choice can be specified using the
|
||
|
|
USREXIT attribute of the pull-down field choice (PDFLDC) tag. The exit program
|
||
|
|
is called immediately after the action specified on the ACTION attribute of the
|
||
|
|
PDFLDC tag is processed.</p>
|
||
|
|
|
||
|
|
<p>Normally, this exit program adds, updates, or removes a list entry for the
|
||
|
|
application when the action list option or pull-down choice action is a command
|
||
|
|
string. The exit program should not change list entries other than the one
|
||
|
|
currently being processed. If it does, remaining UIM list processing may not
|
||
|
|
perform as expected. If the exit program changes the current entry for the list
|
||
|
|
by adding a new entry to the list, the exit program should reset the current
|
||
|
|
entry to the one currently being processed before returning control to the UIM.
|
||
|
|
If the exit program does not do this, remaining UIM list processing may not
|
||
|
|
perform as expected.</p>
|
||
|
|
|
||
|
|
<p>Escape messages received by the UIM from the exit program cause the UIM to
|
||
|
|
stop list processing, and display the messages when the panel is reshown. If
|
||
|
|
the dialog variable identifying the exit program is null (for a pointer
|
||
|
|
variable) or blanks (for a character variable), no exception is reported by the
|
||
|
|
UIM and processing continues as if the USREXIT attribute is not specified.</p>
|
||
|
|
|
||
|
|
<p>The cancel and exit 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 cancel and exit flags should not be turned on by the
|
||
|
|
exit program.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Single Parameter Interface</h3>
|
||
|
|
|
||
|
|
<p>QSYSINC Member Name: EUIALEX</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>5</em></td>
|
||
|
|
<td align="left" valign="top">The exit program is called for an action list
|
||
|
|
option or pull-down choice when ACTFOR=LIST is specified on the PDFLDC
|
||
|
|
tag.</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>Panel name</strong></dt>
|
||
|
|
|
||
|
|
<dd>CHAR(10); positions 25-34
|
||
|
|
|
||
|
|
<p>The name of the panel currently being processed by the UIM.</p>
|
||
|
|
</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>List entry handle</strong></dt>
|
||
|
|
|
||
|
|
<dd>CHAR(4); positions 45-48
|
||
|
|
|
||
|
|
<p>The handle of the list entry being processed by the UIM. The following value
|
||
|
|
may be used:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>EXTE</em></td>
|
||
|
|
<td align="left" valign="top">Processes the extended action entry.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Option number</strong></dt>
|
||
|
|
|
||
|
|
<dd>BINARY(4); positions 49-52
|
||
|
|
|
||
|
|
<p>The option number of the list action or pull-down choice being processed for
|
||
|
|
the specified list entry.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Function qualifier</strong></dt>
|
||
|
|
|
||
|
|
<dd>BINARY(4); positions 53-56
|
||
|
|
|
||
|
|
<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">Performs the action specified on the ENTER or
|
||
|
|
EXTENTER attribute of the list action (LISTACT) tag or the ACTION attribute of
|
||
|
|
the PDFLDC tag.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>-10</em></td>
|
||
|
|
<td align="left" valign="top">Performs the action specified on the PROMPT or
|
||
|
|
EXTPROMPT attribute of the LISTACT tag.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Action results</strong></dt>
|
||
|
|
|
||
|
|
<dd>BINARY(4); positions 57-60
|
||
|
|
|
||
|
|
<p>Set to one of the following values, indicating whether or not the list
|
||
|
|
action or pull-down choice was successful:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">The list action or pull-down choice is
|
||
|
|
successful.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The list action or pull-down choice is
|
||
|
|
unsuccessful.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>A list action or pull-down choice is considered unsuccessful if any of the
|
||
|
|
following occurs:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>An escape message is sent by the action program or command.</li>
|
||
|
|
|
||
|
|
<li>The cancel flag for the job is set on by the action program or
|
||
|
|
command.</li>
|
||
|
|
|
||
|
|
<li>The exit flag for the job is set on by the action program or command.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<blockquote>
|
||
|
|
<p>Conversely, the list action is successful if none of the above occur.</p>
|
||
|
|
</blockquote>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Pull-down field name</strong></dt>
|
||
|
|
|
||
|
|
<dd>CHAR(10); positions 61-70
|
||
|
|
|
||
|
|
<p>The pull-down field name from which the pull-down choice is selected. If the
|
||
|
|
pull-down choice does not have a name, this field is set to blanks.</p>
|
||
|
|
|
||
|
|
<p>When the action being processed is not a pull-down choice, this field is set
|
||
|
|
to blanks.</p>
|
||
|
|
|
||
|
|
<p>This field is available only when the structure level field is set to two or
|
||
|
|
greater.</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: 70%;">
|
||
|
|
<br>
|
||
|
|
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">Panel 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">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">5</td>
|
||
|
|
<td align="left" valign="top">List entry handle</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">Option number</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="left" valign="top">Function qualifier</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">Action results</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Additional parameter for interface level 2:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">9</td>
|
||
|
|
<td align="left" valign="top" width="50%">Pull-down field name</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|