122 lines
5.1 KiB
HTML
122 lines
5.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>Using the User Interface Manager (UIM) APIs</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>Using the User Interface Manager (UIM) APIs</h2>
|
|
|
|
<p>When calling UIM APIs, the calling program must pass arguments by reference.
|
|
That is, all UIM API programs expect the calling program to pass a space
|
|
pointer to each of the argument values. For some HLL compilers, this is the
|
|
only way of passing arguments when calling a program.</p>
|
|
|
|
<p>Unless otherwise noted, all argument values must be in uppercase, and
|
|
left-adjusted with trailing blanks. For example, if a program accepts a special
|
|
value of <samp>"ALL"</samp> for a parameter defined as CHAR(4), <samp>
|
|
"ALL"</samp> must be passed (without the quotes).</p>
|
|
|
|
<br>
|
|
|
|
<h3>Terms and Definitions</h3>
|
|
|
|
<p><strong>Application variable pool.</strong> The set of all dialog variable
|
|
values for an open application.</p>
|
|
|
|
<p><strong>Argument list.</strong> In UIM, this list consists of values that
|
|
are passed to a program.</p>
|
|
|
|
<p><strong>Coded character set identifier (CCSID).</strong> A 32-bit number
|
|
identifying a specific set of encoding scheme identifiers, character set
|
|
identifiers, code page identifiers, and other relevant information that
|
|
uniquely identifies the coded graphic character representation used.</p>
|
|
|
|
<p><strong>Contextual help.</strong> Help information about a single item, such
|
|
as the field on which the cursor is positioned when help is requested.</p>
|
|
|
|
<p><strong>Dialog variable.</strong> A named element in a panel group used to
|
|
pass data values between programs or between a program and a user. The current
|
|
contents of all dialog variables corresponding to variables in the list are
|
|
saved as each entry is added.</p>
|
|
|
|
<p><strong>Error variable.</strong> The dialog variable specified on the ERRVAR
|
|
attribute of the variable definition (VAR) tag. The error variable is used to
|
|
set and test the error status of the dialog variable named on the NAME
|
|
attribute of the VAR tag.</p>
|
|
|
|
<p><strong>Extended action entry.</strong> The first line below the column
|
|
headings in a list. This line contains entry-capable fields for the option
|
|
column and for at least one additional list column.</p>
|
|
|
|
<p><strong>Extended action list area.</strong> A list area of a panel that
|
|
contains an extended action entry.</p>
|
|
|
|
<p><strong>Extended help.</strong> Help information for all the items on the
|
|
display; it contains all contextual help items and can contain additional
|
|
information as well.</p>
|
|
|
|
<p><strong>List entry handle.</strong> A value that uniquely distinguishes an
|
|
entry in a UIM list until it is removed from the list. A list entry handle is
|
|
meaningful only for a particular open application, list, and entry combination.
|
|
It has no meaning in any other open UIM application, or even in the same
|
|
application if the list or the entry is deleted and then re-created.
|
|
Unpredictable results are possible if a list entry handle is used outside of
|
|
this definition.</p>
|
|
|
|
<p><strong>Message reference key.</strong> A unique string of characters that
|
|
identify a particular instance of a message in a queue. The message key can
|
|
also be used to refer to a specific instance of a message in order to move,
|
|
receive, reply to, resend, or move it.</p>
|
|
|
|
<p><strong>Open data path (ODP).</strong> A control block containing
|
|
information about the merged file attributes and information returned by I/O
|
|
operations.</p>
|
|
|
|
<p><strong>Pop-up window.</strong> An area of the screen with visible borders,
|
|
which supplements the dialog occurring in the full- screen panel or in a
|
|
previous pop-up window.</p>
|
|
|
|
<p><strong>Pull-down field choice.</strong> A choice that appears in a
|
|
pull-down menu.</p>
|
|
|
|
<p><strong>Trimming.</strong> An operation performed by removing a list entry
|
|
from the end of the list opposite from the end where the new entry is
|
|
added.</p>
|
|
|
|
<p><strong>Variable buffer.</strong> A buffer used to pass dialog variables
|
|
between the application program and the UIM.</p>
|
|
|
|
<p><strong>Variable record.</strong> A named element of a panel group that
|
|
identifies the content and layout of a buffer of dialog variables.</p>
|
|
|
|
<p><strong>Window.</strong> An area on the display that is treated as a
|
|
separate display. Windows have visible boundaries and appear to overlay the
|
|
display from which they are requested.</p>
|
|
|
|
<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 APIs</a> |
|
|
<a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|