346 lines
10 KiB
HTML
346 lines
10 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>Add Pop-Up Window (QUIADDPW) API</title>
|
||
|
|
<!-- Begin Header Records ========================================== -->
|
||
|
|
<!-- 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. -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!--Edited by Kersten Nov 2001 -->
|
||
|
|
<!-- 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>Add Pop-Up Window (QUIADDPW) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="50%">Application handle</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Pop-up window location</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Row</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Column</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">Error code</td>
|
||
|
|
<td align="left" valign="top">I/O</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Optional Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">6</td>
|
||
|
|
<td align="left" valign="top" width="50%">Depth</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Add Pop-Up Window (QUIADDPW) API begins the ability to display panels
|
||
|
|
within a pop-up window. All subsequent panel displays for the open application
|
||
|
|
remain in the pop-up window until the Remove Pop-up Window (QUIRMVPW) API is
|
||
|
|
called, or until the QUIADDPW API is called again to add another pop-up window.
|
||
|
|
The maximum number of pop-up windows that can be added to an open application
|
||
|
|
is 20.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
||
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<!-- Use this if there are no authorities and locks. -->
|
||
|
|
<p>None.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Application handle</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p> The application handle assigned by the UIM and returned to the application
|
||
|
|
program by the Open Display Application (QUIOPNDA) API when the application is
|
||
|
|
opened.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Pop-up window location</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p> The name of a field used for field-adjacent positioning. Field-adjacent
|
||
|
|
positioning places a pop-up window near a field on the underlying panel. The
|
||
|
|
field name must correspond to a name specified on the NAME attribute on one of
|
||
|
|
the following tags of the immediately underlying panel or pop-up window:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>Command Line (CMDLINE)</li>
|
||
|
|
|
||
|
|
<li>Data Item Group (DATAGRP)</li>
|
||
|
|
|
||
|
|
<li>Data Item (DATAI)</li>
|
||
|
|
|
||
|
|
<li>List Column (LISTCOL)</li>
|
||
|
|
|
||
|
|
<li>List Column Group (LISTGRP)</li>
|
||
|
|
|
||
|
|
<li>Menu Item (MENUI)</li>
|
||
|
|
|
||
|
|
<li>Option Line (OPTLINE)</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>One of these special values may be used to position the window:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*OFFSET</em></td>
|
||
|
|
<td align="left" valign="top">The pop-up window is offset from the top left
|
||
|
|
corner of the most recent underlying panel or pop-up window.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*PULLDOWN</em></td>
|
||
|
|
<td align="left" valign="top">The pop-up window is positioned adjacent to the
|
||
|
|
previous position of the pull-down choice. If the most recent action for the
|
||
|
|
most recently displayed panel was not the selection of a pull-down choice,
|
||
|
|
offset positioning is used.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ROWCOL</em></td>
|
||
|
|
<td align="left" valign="top">The row and column parameters indicate where the
|
||
|
|
upper left corner of the pop-up window appears. Row and column positioning
|
||
|
|
should be used only when displaying a pop-up window over a non-UIM panel, in
|
||
|
|
conjunction with the Set Screen Image (QUISETSC) API.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Row</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p> The absolute row used when row and column positioning is requested. The
|
||
|
|
value is either a positive or negative integer.</p>
|
||
|
|
|
||
|
|
<p> If a negative integer is provided, the last row for the pop-up window is
|
||
|
|
calculated using the absolute value of the integer, relative to the bottom of
|
||
|
|
the display. A pop-up window cannot begin in row one, and a minimum-depth
|
||
|
|
pop-up window must fit at the specified first row.</p>
|
||
|
|
|
||
|
|
<p> When a negative integer is provided, the absolute location of the window is
|
||
|
|
determined by the size of the first panel displayed in the pop-up window. If
|
||
|
|
another panel is displayed in the same window with a smaller width or depth,
|
||
|
|
the location is not recalculated based on the negative integer. If another
|
||
|
|
panel is displayed in the same window with a larger width or depth, the window
|
||
|
|
is changed to use offset positioning.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Column</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p> The absolute column used when row and column positioning is requested. The
|
||
|
|
value is either a positive or a negative integer.</p>
|
||
|
|
|
||
|
|
<p> If a negative integer is provided, the last column for the pop-up window is
|
||
|
|
calculated using the absolute value of the integer, relative to the right side
|
||
|
|
of the display. A pop-up window cannot begin in column one, and a minimum-width
|
||
|
|
pop-up window must fit at the specified first column.</p>
|
||
|
|
|
||
|
|
<p> When a negative integer is provided, the absolute location of the window is
|
||
|
|
determined by the size of the first panel displayed in the pop-up window. If
|
||
|
|
another panel is displayed in the same window with a smaller width or depth,
|
||
|
|
the location is not recalculated based on the negative integer. If another
|
||
|
|
panel is displayed in the same window with a larger width or depth, the window
|
||
|
|
is changed to use offset positioning.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; CHAR(*)
|
||
|
|
|
||
|
|
<p> The structure in which to return error information. For the format of the
|
||
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Optional Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Depth</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The depth of the pop-up window to be displayed.</p>
|
||
|
|
|
||
|
|
<p>If the depth is specified on a panel without a TEXT area defined, it will be
|
||
|
|
ignored and the depth specified on the PANEL tag will be used. If the depth
|
||
|
|
specified on the API is larger than the depth specified on the PANEL tag, the
|
||
|
|
depth specified on the API will be used.</p>
|
||
|
|
|
||
|
|
<p>The maximum supported depth for a pop-up panel depends on what the display
|
||
|
|
device can support. On a device that can only support 24 rows by 80 bytes, the
|
||
|
|
maximum depth of a pop-up window is 21 lines. On a device that can support 27
|
||
|
|
rows by 132 bytes, the maximum depth of a pop-up window is 24 lines.</p>
|
||
|
|
|
||
|
|
<p>The minimum allowed depth is 5 lines.</p>
|
||
|
|
|
||
|
|
<p>The special value of 0 may be specified to indicate that the depth on the
|
||
|
|
PANEL tag should be used. The default value is 0.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF3C90 E</td>
|
||
|
|
<td width="85%" valign="top">Literal value cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A0A E</td>
|
||
|
|
<td align="left" valign="top">Pop-up window depth too small.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A0B E</td>
|
||
|
|
<td align="left" valign="top">Application handle &3 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A0C E</td>
|
||
|
|
<td align="left" valign="top">Application domain error for application
|
||
|
|
&1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A0F E</td>
|
||
|
|
<td align="left" valign="top">Previous error occurred while running application
|
||
|
|
&3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A24 E</td>
|
||
|
|
<td align="left" valign="top">Parameter &1 not passed correctly.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A25 E</td>
|
||
|
|
<td align="left" valign="top">Return code length of &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A3E E</td>
|
||
|
|
<td align="left" valign="top">Application not open for display.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A81 E</td>
|
||
|
|
<td align="left" valign="top">Pop-up window cannot be added at this time.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A82 E</td>
|
||
|
|
<td align="left" valign="top">&4 is not a valid window location.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A83 E</td>
|
||
|
|
<td align="left" valign="top">Row or column given for positioning is not
|
||
|
|
valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF6A85 E</td>
|
||
|
|
<td align="left" valign="top">Attempted to display more than &4 windows at
|
||
|
|
a time.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9872 E</td>
|
||
|
|
<td align="left" valign="top">Program or service program &1 in library
|
||
|
|
&2 ended. Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API 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>
|
||
|
|
|