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

324 lines
8.6 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 Text Area Data</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 Text Area Data</h2>
<p>The exit program can update the data in a text area every time a panel is
displayed and returns control to the UIM through a normal return. The UIM will
then finish formatting the panel and display it. The area formatted by the
application is displayed as defined by the contents of the dialog variable or
by the data pointed to by the dialog variable.</p>
<p>A text area exit program can be specified on the USREXIT attribute of the
text area (TEXT) tag. This attribute specifies the name of a dialog variable
identifying the program to call. The UIM calls the program when:</p>
<ul>
<li>The panel is displayed or redisplayed using display panel UIM
functions.</li>
<li>The user presses a key assigned to the PAGEUP, PAGEDOWN, MOVEtop, or ENTER
dialog commands and the cursor position is such that the text area should be
scrolled.</li>
</ul>
<p>If the dialog variable identifying the program to call is null for a pointer
variable or blanks for a character variable, escape message CPF6A14 is sent to
the calling program. If the exit program returns control normally, any messages
sent to the UIM by the exit program are displayed on the message line.</p>
<p>The UIM does not reevaluate conditions after the text area exit program is
called; therefore, changing dialog variables that affect conditions has no
effect during this display of the panel.</p>
<p>The exit and cancel flags for the job are not reset before the exit program
is called and the flag 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: EUITAEX</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>11</em> </td>
<td align="left" valign="top">The exit program is called to update the text
area data.</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>Function key pressed</strong></dt>
<dd>BINARY(4); positions 35-38
<p>The function key that is pressed:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em> </td>
<td align="left" valign="top">A key other than F1-F24.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>1-24</em> </td>
<td align="left" valign="top">A function key (F1-F24) is pressed.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Function key qualifier</strong></dt>
<dd>BINARY(4); positions 39-42
<p>Provides information about why the user exit program is being called.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em> </td>
<td align="left" valign="top">The exit program is called for the initial
display or redisplay of the panel.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em> </td>
<td align="left" valign="top">A key assigned to the PAGEUP dialog command is
pressed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-2</em> </td>
<td align="left" valign="top">A key assigned to the PAGEDOWN dialog command is
pressed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-3</em> </td>
<td align="left" valign="top">A key assigned to the MOVEtop dialog command is
pressed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-4</em> </td>
<td align="left" valign="top">A key assigned to the ENTER dialog command is
pressed.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Text area width</strong></dt>
<dd>BINARY(4); positions 43-46
<p>The width of the text area within this panel to be formatted.</p>
</dd>
<dt><strong>Text area depth</strong></dt>
<dd>BINARY(4); positions 47-50
<p>The depth of the text area within this panel to be formatted.</p>
</dd>
<dt><strong>Panel bidirectional orientation</strong></dt>
<dd>CHAR(1); positions 51-51
<p>Identifies the attribute orientation of the panel group. Set one of the
following values:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>N</em> </td>
<td align="left" valign="top">BIDI=NONE is specified or the default on the
panel group (PNLGRP) tag.</td>
</tr>
<tr>
<td align="left" valign="top"><em>L</em> </td>
<td align="left" valign="top">BIDI=LTR is specified or the default on the
PNLGRP tag.</td>
</tr>
<tr>
<td align="left" valign="top"><em>R</em> </td>
<td align="left" valign="top">BIDI=RTL is specified or the default on the
PNLGRP tag.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Device code page</strong></dt>
<dd>BINARY(4); positions 52-55
<p>The number for the code page of the requester's display device.</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: 80%;">
<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">Function key pressed</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">Function key qualifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Text area width</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">Text area depth</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">Panel bidirectional orientation</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(1)</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">Device code page</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: V3R1
<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>