474 lines
13 KiB
HTML
474 lines
13 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>Put Window Message (QsnPutWinMsg) 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. -->
|
|
<!-- DSMMST1 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
|
<!-- at RCHVMW2 on 29 Jan 1999 at 16:05:09 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File Edited November 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>Put Window Message (QsnPutWinMsg) API</h2>
|
|
|
|
<div class="box" style="width: 75%;">
|
|
<br>
|
|
Required Parameter:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="50%">Window handle</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Omissible Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">2</td>
|
|
<td align="left" valign="top" width="50%">Message</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Message length</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">Lock keyboard</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">Message identifier</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(7)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Qualified message file name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(20)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</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">8</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">9</td>
|
|
<td align="left" valign="top">Starting monochrome attribute</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">Ending monochrome attribute</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">Starting color attribute</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="left" valign="top">Ending color attribute</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">13</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>
|
|
Returned Value:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%"> </td>
|
|
<td align="left" valign="top" width="50%">Return code</td>
|
|
<td align="left" valign="top" width="20%">Output</td>
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Service Program: QSNAPI<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Put Window Message (QsnPutWinMsg) API places an error message on the
|
|
message line for the given window. This API is valid only if the window has a
|
|
message line specified for it.</p>
|
|
|
|
<br>
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>None</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Window handle</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>A handle for the window in which the message should be placed.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Omissible Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Message</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The message to be displayed. If the message does not fit within the window,
|
|
it is truncated to fit. If the message length parameter is specified as
|
|
nonzero, the message parameter is required. The message or the message ID
|
|
parameter must be specified. If the message parameter is specified, the message
|
|
ID parameter is ignored and no help key support is available for the
|
|
message.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Message length</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number of bytes of message data to be displayed.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Lock keyboard</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>Whether the keyboard should be placed in prehelp error state of not. The
|
|
possible values are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td valign="top"><em>0</em></td>
|
|
<td valign="top">Do not place the keyboard in prehelp error state.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1</em></td>
|
|
<td valign="top">Place the keyboard in prehelp error state. If 1 is specified,
|
|
the processing of this API follows that of the QsnSetErr API and the
|
|
QsnPutWinMsg API must be followed by an AID-associated read API. This is the
|
|
default.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Message identifier</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(7)
|
|
|
|
<p>The identifying code for the predefined message to be displayed. The first
|
|
level text is displayed. If the user moves the cursor to the message line and
|
|
presses the Help key, the message <samp>No help text available</samp> is
|
|
displayed. This parameter is required if the message parameter is omitted.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Qualified message file name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The name of the message file from which to retrieve the message information,
|
|
and the library in which the message file resides. This parameter is required
|
|
if the message parameter is omitted. The format of this parameter is:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Bytes</th>
|
|
<th align="left" valign="top">Value</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1-10</em></td>
|
|
<td valign="top">Message file name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>11-20</em></td>
|
|
<td valign="top">Message file library. This can be an actual library name or
|
|
one of the special values *CURLIB or *LIBL.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Row</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The relative window row at which to position the cursor when the message is
|
|
displayed. To move the cursor, the API must be followed by an AID-associated
|
|
read API.</p>
|
|
|
|
<p>If both row and column are omitted or specified with a zero value, the
|
|
cursor is not moved. Row and column must both be specified or omitted; one
|
|
cannot be specified if the other is omitted.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Column</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The relative window column at which to position the cursor when the message
|
|
is displayed.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Starting monochrome attribute</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The initial screen attribute for monochrome displays. If this parameter is
|
|
omitted and monochrome attributes are to be used, no initial attribute is
|
|
written to the display for the data.</p>
|
|
|
|
<p>The monochrome and color attributes parameters are the initial and ending
|
|
screen attributes: an initial and ending screen attribute to be used for a
|
|
monochrome or a color display, respectively. One of these parameters will be
|
|
selected based on the underlying display type, and the other will be discarded.
|
|
Any of the attributes can be specified as a special value, X'00', indicating
|
|
that no screen attribute should be written to the display. If the initial
|
|
screen attribute is specified as an actual attribute, the data column, if
|
|
specified, must be greater than or equal to 2. The initial screen attribute, if
|
|
not X'00', will be written to the screen at the column previous to the first
|
|
data character if row and column are specified, otherwise to the current
|
|
display address. The ending screen attribute, if not X'00', will be written at
|
|
the column directly after the last data character.</p>
|
|
|
|
<p>See <a href="dsm1e.htm#HDRSCRATTR">Screen Attribute Characters</a> for a
|
|
description of the screen attribute values.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Ending monochrome attribute</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The ending screen attribute for monochrome displays. If this parameter is
|
|
omitted and monochrome attributes are to be used, no ending attribute is
|
|
written to the display for the data.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Starting color attribute</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The initial screen attribute for color displays. If this parameter is
|
|
omitted and color attributes are to be used, no initial attribute is written to
|
|
the display for the data. See <a href="dsm1e.htm#HDRSCRATTR">Screen Attribute
|
|
Characters</a> for a description of the screen attribute values.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Ending color attribute</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The ending screen attribute for color displays. If this parameter is omitted
|
|
and color attributes are to be used, no ending attributes are written to the
|
|
display for the data.</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>. If this
|
|
parameter is omitted, diagnostic and escape messages are issued to the
|
|
application.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Returned Value</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Return code</strong></dt>
|
|
|
|
<dd>OUTPUT; BINARY(4)
|
|
|
|
<p>A return code indicating the result of the operation. The value returned
|
|
will be 0 if the operation was successful, or -1 otherwise.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA307 E</td>
|
|
<td valign="top">Screen position &1, &2 outside of display or window
|
|
area.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA30D E</td>
|
|
<td valign="top">Invalid screen attribute.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA31E E</td>
|
|
<td valign="top">Required parameter &1 omitted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA333 E</td>
|
|
<td valign="top">Parameter &1 not positive integer value.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA335 E</td>
|
|
<td valign="top">Screen address parameter error.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA343 E</td>
|
|
<td valign="top">Output operation not done.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA344 E</td>
|
|
<td valign="top">The file &2 in library &3 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA345 E</td>
|
|
<td valign="top">The invite active flag is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA3A4 E</td>
|
|
<td valign="top">Specified window is not active.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA3A7 E</td>
|
|
<td valign="top">Window does not have a message line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA3A8 E</td>
|
|
<td valign="top">Error occurred retrieving message text.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA3AA E</td>
|
|
<td valign="top">Window handle incorrect.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA3AB E</td>
|
|
<td valign="top">The value for &1 must be '0' or '1'.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V2R3
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"dsm.htm">Dynamic Screen Manager APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|