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

217 lines
6.2 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 Application Formatted 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 Application Formatted Data</h2>
<p>The exit program can update the data formatted by the application every time
a panel is displayed, and returns control to the UIM through a normal return.
The UIM then finishes formatting the panel and displays it. The area formatted
by the application is displayed as defined by the contents of the dialog
variable.</p>
<p>An application format exit program can be specified on the USREXIT attribute
of the application formatted area (APPFMT) tag. This attribute specifies the
name of a dialog variable identifying the program to call.</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>This exit program is called during the formatting of the panel whenever the
panel is displayed. If the dialog variable identifying the program is nulls for
a pointer variable or blanks for a character variable, no exception is reported
and processing continues as if the USREXIT attribute is not specified.</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>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: EUIAFEX</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>7</em></td>
<td align="left" valign="top">The exit program is called to update the
application formatted 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>Panel bidirectional orientation</strong></dt>
<dd>CHAR(1); positions 35-35
<p>Identifies the attribute orientation of the panel group.</p>
<p>Set to 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 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 on the PNLGRP tag.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Device code page</strong></dt>
<dd>BINARY(4); positions 36-39
<p>The number of 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: 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 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">5</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: 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>