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

240 lines
6.4 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!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 a Cursor-Sensitive Prompt</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>
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Exit Program for a Cursor-Sensitive Prompt</h2>
<p>An exit program for handling a cursor prompt request can be specified on the
PROMPT attribute of the data item (DATAI), data item extender (DATAIX), and
list column (LISTCOL) tags. This attribute specifies the name of a dialog
variable identifying the program to call.</p>
<p>This dialog variable cannot be blanks or nulls. The UIM cannot process a
prompt request without the exit program.</p>
<p>Normally, the exit program displays a selection list panel. Such a list
panel allows the user to select one or more entries from a list of possible
choices. The application then sets the selected choices in the appropriate
dialog variables, which are shown when the UIM redisplays the panel where the
prompt function was requested.</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: EUICSEX</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>8</em></td>
<td align="left" valign="top">The exit program is called to provide
cursor-sensitive prompting.</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>Panel element type</strong></dt>
<dd>CHAR(1); positions 35-35
<p>One of the following values identify the type of panel element prompt:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Prompts for a data item (DATAI tag).</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Prompts for a data item extender (DATAIX
tag).</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Prompts for a list column (LISTCOL tag).</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Reserved</strong></dt>
<dd>CHAR(1); positions 36-36<br>
<br>
</dd>
<dt><strong>Dialog variable name</strong></dt>
<dd>CHAR(10); positions 37-46
<p>The name of the dialog variable where the cursor was positioned when the
prompt function was requested.</p>
</dd>
<dt><strong>List name</strong></dt>
<dd>CHAR(10); positions 47-56
<p>The name of the list where the cursor was positioned when the prompt
function was requested. This field is set only when the panel element type
field indicates a LISTCOL tag is prompted.</p>
</dd>
<dt><strong>List entry handle</strong></dt>
<dd>CHAR(4); positions 57-60
<p>The list entry handle where the cursor was positioned when the prompt
function was requested. This field is set only when the panel element type
field indicates a LISTCOL tag is prompted.</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: 60%;">
<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">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">Panel element type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(1)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Dialog variable 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>
</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>