270 lines
8.1 KiB
HTML
270 lines
8.1 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 Conditioning Panel Items</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. -->
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- XUICONDE SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
|
|
<!-- at RCHVMW2 on 16 Nov 1998 at 14:39:59 -->
|
|
<!--End Header Records -->
|
|
<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 Conditioning Panel Items</h2>
|
|
|
|
<p>An exit program may be called during condition evaluation for conditions
|
|
specified on the EXPR attribute of the COND tag and the LINKWHEN and UNLESSn
|
|
attributes of the LINK tag.</p>
|
|
|
|
<p>The exit program can be provided for those instances when the determination
|
|
of user class or existence of an object is not sufficient.</p>
|
|
|
|
<p>The exit program is called during the evaluation of conditions on a panel.
|
|
For hypertext link calls, this program will be run every time. When the CHKPGM
|
|
function is specified on the COND tag, the EVAL attribute on the COND tag will
|
|
determine when this program is called. A return code set by the exit program
|
|
will indicate to UIM whether the CHKPGM function should be evaluated to true or
|
|
false.</p>
|
|
|
|
<p>The default for the function will be false if the exit program cannot be
|
|
called. A message will be displayed at the bottom of the panel in the case of
|
|
an error on the call to the exit program.</p>
|
|
|
|
<p>If the exit program is being
|
|
called to process a COND tag on a menu item in a *MENU object, the multiple
|
|
parameter interface will always be used. The multiple parameter interface will
|
|
always be used when processing the the LINKWHEN and UNLESSn attributes on a
|
|
hypertext link also. </p>
|
|
|
|
<br>
|
|
<h3>Single Parameter Interface</h3>
|
|
|
|
<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>12</em></td>
|
|
<td align="left" valign="top">The exit program is called to evaluate the
|
|
condition for the given panel group, menu, or hypertext link.</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. This value will be set only when processing a *PNLGRP object. It will be
|
|
set to blanks when the exit program is called for a *MENU object or LINK tag
|
|
condition processing.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Object name</strong></dt>
|
|
|
|
<dd>CHAR(10); positions 25-34
|
|
|
|
<p>The name of the panel group or menu object being processed. If the exit
|
|
program is called to process the condition on a LINKWHEN or UNLESSn attribute
|
|
on a LINK tag, this field will contain the name of the panel group that
|
|
contains the help identifier named in the LINK tag.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Library name</strong></dt>
|
|
|
|
<dd>CHAR(10); positions 35-44
|
|
|
|
<p>The name of the library containing the object being processed. If the exit
|
|
program is called to process the condition on a LINKWHEN or UNLESSn attribute
|
|
on a LINK tag, this field will contain the name of the library that contains
|
|
the panel group named in the previous parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Object type</strong></dt>
|
|
|
|
<dd>CHAR(10); positions 45-54
|
|
|
|
<p>The type of object (*MENU or *PNLGRP) being processed.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Help module name</strong></dt>
|
|
|
|
<dd>CHAR(32); positions 55-86
|
|
|
|
<p>The name of the help module being processed when the exit program is called
|
|
to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag. When
|
|
processing conditions on a menu or panel item, this field will be blank.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Panel name</strong></dt>
|
|
|
|
<dd>CHAR(10); positions 87-96
|
|
|
|
<p>The name of the panel being processed. This value will be blank when the
|
|
exit program is called to process the condition on a LINKWHEN or UNLESSn
|
|
attribute on a LINK tag.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Condition name</strong></dt>
|
|
|
|
<dd>CHAR(10); positions 97-106
|
|
|
|
<p>The name of the condition currently being evaluated. This is the name as it
|
|
was entered on the COND NAME attribute of the panel group source. If the exit
|
|
program is called to process the condition on a LINKWHEN or UNLESSn attribute
|
|
on a LINK tag, this field will be set to blanks.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Return code</strong></dt>
|
|
|
|
<dd>CHAR(1); position 107
|
|
|
|
<p>Return code from exit program indicating true or false condition. If a value
|
|
other than one of those listed below is returned, the condition will be set to
|
|
false.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Condition of the CHKPGM function is true.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Condition of the CHKPGM function is false.</td>
|
|
</tr>
|
|
</table>
|
|
</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>
|
|
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">Object 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">Library 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">Object type</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">Help module name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(32)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</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">8</td>
|
|
<td align="left" valign="top">Condition name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="left" valign="top">Return code</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</div>
|
|
|
|
<br>
|
|
<hr>
|
|
Exit program introduced: V4R4
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<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></center>
|
|
</body>
|
|
</html>
|
|
|