838 lines
26 KiB
HTML
838 lines
26 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>Display Panel (QUIDSPP) 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>Display Panel (QUIDSPP) 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">Function requested</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Binary(4)</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">Redisplay option</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">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Optional Parameter Group 1:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">6</td>
|
|
<td align="left" valign="top" width="50%">User task</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Call stack counter</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">Call message queue</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="left" valign="top">Message reference key</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">Cursor position option</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">11</td>
|
|
<td align="left" valign="top">Last list entry</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="left" valign="top">Error list entry</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">13</td>
|
|
<td align="left" valign="top">Wait time</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Optional Parameter Group 2:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">14</td>
|
|
<td align="left" valign="top" width="50%">Length of call message queue
|
|
name</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">15</td>
|
|
<td align="left" valign="top">Call qualification</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(20)</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Display Panel (QUIDSPP) API displays a panel and waits for the user to
|
|
press either a function key or the Enter key.</p>
|
|
|
|
<p>The values for all I/O fields in the panel definition are taken from dialog
|
|
variables in the variable pool. If the panel contains list areas, these values
|
|
are also taken from list entries in the lists associated with the open
|
|
application.</p>
|
|
|
|
<p>The application program can also control which list entry is initially
|
|
displayed at the top of a list area by using the Set List Attributes (QUISETLA)
|
|
API. If the panel contains a list area displaying an incomplete list and if the
|
|
list does not have enough entries to fill the list area, the UIM calls the
|
|
program identified by the program dialog variable parameter of the QUISETLA API
|
|
to add more list entries. The program is called repeatedly until the requested
|
|
number of entries is added or until the list is marked as complete.</p>
|
|
|
|
<p>If the panel contains an extended action list area and if the list is not
|
|
currently active in the open application, the list is activated by the QUIDSPP
|
|
API.</p>
|
|
|
|
<p>Any information the user enters into input fields on the panel is validated
|
|
according to the specifications of the tag language, then saved in the
|
|
corresponding dialog variables and list entries.</p>
|
|
|
|
<p>Control returns to the application program only after all necessary
|
|
functions are completed as defined by UIM processing rules and tag language
|
|
specifications. The application program can retrieve dialog variables and list
|
|
entries after the QUIDSPP API returns to determine what values were specified
|
|
by the user.</p>
|
|
|
|
<p>The QUIDSPP API can be called with a long or short argument list. For the
|
|
short argument list, arguments must be passed to the QUIDSPP API with the
|
|
required parameters described below. For the long argument list, arguments must
|
|
be passed to the QUIDSPP API with all the required and optional parameters
|
|
described below.</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>Function requested</strong></dt>
|
|
|
|
<dd>OUTPUT; BINARY(4)
|
|
|
|
<p> The function requested by the user. Only special UIM-defined functions and
|
|
functions using the RETURN dialog command are returned to the application
|
|
program. Any other functions requested by the user are either handled by the
|
|
UIM or rejected. If they are rejected, an error message is displayed on the
|
|
panel.</p>
|
|
|
|
<p> The RETURN dialog command can be specified as follows:</p>
|
|
|
|
<ul>
|
|
<li>On the ACTION attribute of the key list item (KEYI), pull-down field choice
|
|
(PDFLDC), or menu item (MENUI) UIM tags</li>
|
|
|
|
<li>On the ENTER and SELECT attributes of the display panel (PANEL) UIM
|
|
tag</li>
|
|
</ul>
|
|
|
|
<p> The RETURN dialog command returns numbers from 1 through 32 767. The
|
|
return values for UIM-defined functions are as follows:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The enter function is requested. This value is
|
|
returned in the following situations:
|
|
|
|
<ul>
|
|
<li>When the user has entered options in the list for a panel with a list area
|
|
of ACTOR=CALLER.</li>
|
|
|
|
<li>When enter has been pressed in a text area and the text area exit program
|
|
has sent message CPF6A07 to end the enter function and return to the
|
|
application program.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>-4</em></td>
|
|
<td align="left" valign="top">The exit function is requested.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>-8</em></td>
|
|
<td align="left" valign="top">The cancel function is requested.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" nowrap><em>-10</em></td>
|
|
<td align="left" valign="top">The prompt function is requested. This value is
|
|
returned only for a panel with an ACTOR=CALLER list area, and only when the
|
|
user has entered options in the list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>-20</em></td>
|
|
<td align="left" valign="top">No function was requested before the time
|
|
specified on the wait time parameter has ended. This value is returned only
|
|
when the wait time parameter specifies a time-out value.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Panel name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p> The name of the panel to display. The panel must be defined in the panel
|
|
group for the open application.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Redisplay option</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p> Indicates whether or not the panel is formatted and displayed as a
|
|
first-time display or as a redisplay.</p>
|
|
|
|
<p> One of the following values must be used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>Y</em></td>
|
|
<td align="left" valign="top">The panel is formatted as a redisplay. If the
|
|
panel has not been displayed in the application before, processing for the
|
|
first-time display is done and this parameter is ignored.
|
|
|
|
<p> Cursor positioning that is controlled by the program is ignored when the
|
|
redisplay option is used. Cursor positioning controlled by action list
|
|
processing is supported when the redisplay option is used.</p>
|
|
|
|
<p> Dialog variables are edited for a new displayable value only if the
|
|
variable pool contains a value more current than the value from the last time
|
|
the panel was displayed. When VARUPD=NO is processed, the panel is redisplayed
|
|
with values entered in input fields but not stored in the variable pool.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>N</em></td>
|
|
<td align="left" valign="top">The panel is formatted as a first-time display.
|
|
The panel is displayed with the first conditioned-on item at the top of each
|
|
pageable data and menu area. Pageable information areas are positioned at the
|
|
first line of text. All dialog variables displayed on the screen are edited to
|
|
produce a displayable value.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</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 1</h3>
|
|
|
|
<dl>
|
|
<dt><strong>User task</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>Indicates whether or not this panel is the logical start of a new user task.
|
|
The value used determines whether or not the UIM returns to the application
|
|
program when the EXIT dialog command is requested by a lower level program,
|
|
such as an action on the KEYI tag.</p>
|
|
|
|
<p>The user task has no effect on UIM operations when the EXIT dialog command
|
|
is specified directly in the definition of this panel as the function key,
|
|
pull-down choice, or menu item action.</p>
|
|
|
|
<p>One of the following values must be specified:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>N</em></td>
|
|
<td align="left" valign="top">This panel is the logical start of a new user
|
|
task. If the user generates the EXIT dialog command at a lower call level (for
|
|
example, by pressing the exit function key on a panel displayed by a list
|
|
action from the original panel), this panel is redisplayed without returning
|
|
control to the application program.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>O</em></td>
|
|
<td align="left" valign="top">This panel is not the start of a new user task.
|
|
If the user generates the EXIT dialog command at a lower call level, control
|
|
returns to the application program with an indication that the exit function
|
|
was requested. This is the default value when a short argument list is passed
|
|
to the QUIDSPP API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Call stack counter</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>A number identifying the location in the program stack of the call message
|
|
queue for the UIM to use. This parameter is used with the call message queue
|
|
parameter.</p>
|
|
|
|
<p>Any nonnegative number can be specified for the relative program call
|
|
number.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The message queue of the program specified in the
|
|
call message queue parameter. This is the default value when a short argument
|
|
list is passed to the QUIDSPP API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The message queue of the program that calls the
|
|
program specified in the call message queue parameter is used for messages
|
|
displayed to the user.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>n</em></td>
|
|
<td align="left" valign="top">The message queue of the <em>n</em>th program up
|
|
the stack from the program specified in the call message queue parameter is
|
|
used for messages displayed to the user.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Call message queue</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The name of the message queue for the UIM to use, or the name of the program
|
|
to start counting from when using a value other than zero for the call stack
|
|
counter parameter. The program you specify must be in the call stack. The UIM
|
|
will:</p>
|
|
|
|
<ul>
|
|
<li>Receive a message from this queue to initially display on the message line
|
|
of the panel. This is done using the value passed for the message reference key
|
|
parameter.</li>
|
|
|
|
<li>Move to this message queue all completion, information, diagnostic, and
|
|
escape messages sent to the UIM by programs or commands called to process an
|
|
action defined in the panel. Note that escape messages are changed to
|
|
diagnostic messages when they are moved.</li>
|
|
</ul>
|
|
|
|
<p>The following special value can be used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CALLER</em></td>
|
|
<td align="left" valign="top">The application program calling the QUIDSPP API
|
|
is the starting point for identifying the call message queue. This is the
|
|
default value when a short argument list is passed to the QUIDSPP API.
|
|
|
|
<p>This parameter can be from 1 to 256 characters in length. The length of call
|
|
message queue parameter specifies this parameter's length. If the length of
|
|
call message queue parameter is not used, then the length of this parameter is
|
|
assumed to be 10 characters. If further qualification is needed to identify the
|
|
call, the call qualification parameter can be used.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Message reference key</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(4)
|
|
|
|
<p>The messages in the call message queue that are displayed on the panel. The
|
|
call message queue is identified by the call stack counter parameter and the
|
|
call message queue parameter. This parameter must be set to the message
|
|
reference key for the first (oldest) message on the call message queue that
|
|
should be displayed on the panel. One of the following special values can be
|
|
used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>(blank)</em></td>
|
|
<td align="left" valign="top">No messages are shown to the user on the initial
|
|
panel, even if there are messages in the call message queue. This is the
|
|
default value when a short argument list is passed to the Display Panel
|
|
(QUIDSPP) API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>FRST</em></td>
|
|
<td align="left" valign="top">All new messages in the call message queue,
|
|
starting with the first new message in the queue, are presented on the initial
|
|
panel.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Cursor position option</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The rules that determine the initial position of the cursor when the panel
|
|
is displayed. This parameter controls only the initial cursor placement when
|
|
the panel is displayed by the QUIDSPP API. When a panel is redisplayed by the
|
|
UIM or by the application program, the cursor remains where it was left by the
|
|
user.</p>
|
|
|
|
<p>One of the following values must be used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>A</em></td>
|
|
<td align="left" valign="top">Cursor positioning for action list processing is
|
|
performed. This value is used when the panel is redisplayed after action list
|
|
processing when ACTOR=CALLER is on the list area (LIST) tag. The cursor and
|
|
list are positioned as defined by the last list entry and error list entry
|
|
parameters.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>D</em></td>
|
|
<td align="left" valign="top">Default cursor positioning is performed. The
|
|
specific cursor position depends on whether or not any variables or list
|
|
entries associated with the panel are marked in error. This is the default
|
|
value when a short argument list is passed to the display panel (QUIDSPP)
|
|
API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>P</em></td>
|
|
<td align="left" valign="top">Cursor positioning that is controlled by the
|
|
program is performed. The cursor is positioned using the current value of the
|
|
dialog variables associated with the CSRVAR, CSRPOS, CSRLST, and CSREID
|
|
attributes of the panel definition (PANEL) tag. Cursor positioning controlled
|
|
by the program is allowed only for a panel containing all four cursor
|
|
positioning attributes.
|
|
|
|
<p>With cursor positioning controlled by the program, each pageable, nonlist
|
|
area is repositioned to make sure that the first input field in error is
|
|
visible, but the cursor is not positioned at the first input field in error. If
|
|
the value of any of the dialog variables for cursor position identified in the
|
|
panel definition is unusable, the cursor defaults to the first input field on
|
|
the panel.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Last list entry</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(4)
|
|
|
|
<p>The list entry handle for the last action list entry that had an action
|
|
processed.</p>
|
|
|
|
<p>This information is used to position the cursor. Cursor positioning for
|
|
action list processing must be specified in the cursor position option
|
|
parameter or this parameter is ignored. One of the following special values can
|
|
be used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>EXTE</em></td>
|
|
<td align="left" valign="top">The last list action processed is for the
|
|
extended action entry.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>NONE</em></td>
|
|
<td align="left" valign="top">The application is providing no value for this
|
|
parameter. This is the default value when a short argument list is passed to
|
|
the Display Panel (QUIDSPP) API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Error list entry</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(4)
|
|
|
|
<p>The list entry handle for the first and only list entry that had an error
|
|
while processing list actions. This parameter is also set when action list
|
|
processing is stopped because a user pressed F3 (Exit) or F12 (Cancel). This
|
|
information displays the correct page of list information.</p>
|
|
|
|
<p>Cursor positioning for action list processing must be specified in the
|
|
cursor position option parameter, or this parameter is ignored.</p>
|
|
|
|
<p>One of the following special values can be used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>EXTE</em></td>
|
|
<td align="left" valign="top">The extended action entry is in error; the UIM
|
|
does not reposition the list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>NONE</em></td>
|
|
<td align="left" valign="top">The application is providing no value for this
|
|
parameter. This is the default value when a short argument list is passed to
|
|
the Display Panel (QUIDSPP) API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Wait time</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number of seconds to wait for data to become available from the work
|
|
station. After this amount of time, the keyboard locks, control returns to the
|
|
application, and the function requested parameter returns an indication that
|
|
the wait time ended. Because the wait time ended, input dialog variables
|
|
associated with the panel are not updated. The number of seconds specified
|
|
should be a positive integer.</p>
|
|
|
|
<p>One of the following special values can be used:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top" nowrap><em>-1</em></td>
|
|
<td align="left" valign="top">The UIM waits indefinitely until data becomes
|
|
available from the work station. This is the default value when a short
|
|
argument list is passed to the Display Panel (QUIDSPP) API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The UIM does not wait for data to become
|
|
available from the work station. The panel is displayed with the keyboard
|
|
locked, and control returns immediately to the application with an indication
|
|
in the function requested parameter that the wait time ended.</td>
|
|
</tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<br>
|
|
<h3>Optional Parameter Group 2</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Length of call message queue name</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the call message queue name. Valid values for this parameter
|
|
range from 1 to 256. If the value is not valid, an error will occur.</p>
|
|
|
|
<p>The default value for this parameter is 10.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Call qualification</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The name of the module and bound program that contain the procedure. This
|
|
value is used to further qualify the procedure identified in the call message
|
|
queue parameter. The first 10 characters specify the module name, and the
|
|
second 10 characters specify the bound program name. When the call
|
|
qualification parameter is specified, the call stack will be searched only for
|
|
a procedure within a bound program.</p>
|
|
|
|
<p>If this parameter is not used, only the call message queue parameter will be
|
|
used to identify the call.</p>
|
|
|
|
<p>The special value of *NONE can be used for the module or bound program name,
|
|
or for both. When *NONE is specified for one of the names, then that name will
|
|
not be used when searching for the qualified procedure. If *NONE is specified
|
|
for both names, only the call message queue parameter will be used to identify
|
|
the call. Original program model (OPM) programs should specify *NONE for both
|
|
names.</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">CPF3C36 E</td>
|
|
<td width="85%" valign="top">Number of parameters, &1, entered for this API
|
|
was not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td align="left" valign="top">Literal value cannot be changed.</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">CPF6A11 E</td>
|
|
<td align="left" valign="top">Value is not correct. Reason code is &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A13 E</td>
|
|
<td align="left" valign="top">Application &3 closed prematurely.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A14 E</td>
|
|
<td align="left" valign="top">Program defined by variable &4 cannot be
|
|
called.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A15 E</td>
|
|
<td align="left" valign="top">Errors occurred in list exit program.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A22 E</td>
|
|
<td align="left" valign="top">Panel cannot be displayed in a window.</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">CPF6A3F E</td>
|
|
<td align="left" valign="top">Panel &4 was not found in panel group
|
|
&1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A4A E</td>
|
|
<td align="left" valign="top">Panel &4 is too large to display as a pop-up
|
|
window.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A4B E</td>
|
|
<td align="left" valign="top">Value for Redisplay Option parameter not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A40 E</td>
|
|
<td align="left" valign="top">Panel &4 is already in use.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A41 E</td>
|
|
<td align="left" valign="top">Default cursor positioning required for panel
|
|
&4.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A42 E</td>
|
|
<td align="left" valign="top">Display of panel &4 not allowed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A43 E</td>
|
|
<td align="left" valign="top">Cannot use program message queue &6.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF6A50 E</td>
|
|
<td align="left" valign="top">Error was found during display file or printer
|
|
file operation.</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>
|
|
|