402 lines
12 KiB
HTML
402 lines
12 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>Pad for N Positions (QsnWrtPad) 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 October 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>Pad for N Positions (QsnWrtPad) API</h2>
|
|
|
|
<div class="box" style="width: 70%;">
|
|
<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%">Pad character</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">2</td>
|
|
<td align="left" valign="top">Number of bytes</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Omissible Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">3</td>
|
|
<td align="left" valign="top" width="50%">Field ID</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">4</td>
|
|
<td align="left" valign="top">From row</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">From column</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Command buffer handle</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Low-level environment handle</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">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 Pad for N Positions (QsnWrtPad) API pads the display with the given pad
|
|
character for the specified number of bytes. Padding starts at the row and
|
|
column specified, or at the current display address if these parameters are
|
|
omitted. To allow the QsnWrtPad operation to insert a group of characters
|
|
without overwriting the ending screen attribute, the following conditions must
|
|
be satisfied:</p>
|
|
|
|
<ul>
|
|
<li>The operation is an indirect operation.</li>
|
|
|
|
<li>The row and column parameters are omitted.</li>
|
|
|
|
<li>The low-level environment description does not indicate that DBCS data is
|
|
being used.</li>
|
|
|
|
<li>The previous command saved in the command buffer was a Write Data
|
|
(QsnWrtDta) operation.</li>
|
|
</ul>
|
|
|
|
<p>If the row and column parameters are omitted and the command is either a
|
|
direct operation or the buffer specified does not contain a preceding output
|
|
operation that sets the display address, then the current display address is
|
|
set to row 1, column 1, prior to writing the pad characters.</p>
|
|
|
|
<p>If the from-row and from-column parameters are specified, this command
|
|
corresponds indirectly to the 5250 Write to Display (WTD) command with a Set
|
|
Buffer Address order. (For an indirect operation, a WTD is placed in the
|
|
command buffer only if one does not already exist in the buffer.)</p>
|
|
|
|
<br>
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>None</p>
|
|
|
|
<br>
|
|
<h3>Restrictions</h3>
|
|
|
|
<p>The same restrictions apply as for the Write Data (QsnWrtDta) API.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Pad character</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The pad character to pad the screen with.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Number of bytes</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number of bytes to pad the screen for.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Omissible Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Field ID</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The field ID indicating the field at which to set the display address. If
|
|
this parameter is specified with a nonzero value, the row and column parameters
|
|
are ignored and the row and column values corresponding to the field ID are
|
|
used to set the display address. If neither the field ID or row and column
|
|
parameters are specified, the current display address is used.</p>
|
|
</dd>
|
|
|
|
<dt><strong>From row</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The row at which to write the first pad character. The row parameter must
|
|
refer to a row no greater than the current screen or window mode height (if
|
|
window mode is enabled). The actual screen row used for a screen I/O operation
|
|
is calculated using the formula base+offset=actual. The base is the row
|
|
location of the top window border (0 for full screen) if offset is positive, or
|
|
the row location of the bottom window border (screen height plus 1 for full
|
|
screen) if offset is negative. The offset is the row parameter value specified,
|
|
and actual is the actual screen row to be used. A CPFA307 error occurs if an
|
|
incorrect row value is specified.</p>
|
|
|
|
<p>If both the from-row and from-column parameters are omitted, the pad
|
|
characters are written starting at the current display address. If this is the
|
|
case and the command is a direct operation, or the buffer specified does not
|
|
contain a preceding output operation that sets the display address, the current
|
|
display address is set to row 1, column 1, prior to writing the pad characters.
|
|
Both the from-row and from-column parameters must be specified, or both
|
|
parameters must be omitted.</p>
|
|
</dd>
|
|
|
|
<dt><strong>From column</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The column at which to write the first pad character. The column parameter
|
|
must refer to a column no greater than the current screen or window mode width
|
|
(if window mode is on). The actual screen column used for a screen I/O
|
|
operation is calculated using the formula base+offset=actual. The base is the
|
|
column location of the left window border (0 for full screen) if offset is
|
|
positive, or the column location of the center window border (screen width plus
|
|
1 for full screen) if offset is negative. The offset is the column parameter
|
|
value specified, and actual is the actual screen column to be used. A CPFA307
|
|
error occurs if an incorrect column value is specified.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Command buffer handle</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>A handle for the command buffer in which to store the command. If this
|
|
parameter is omitted or specified as 0, this is a direct operation and the pad
|
|
characters are written to the screen at the current display address. Otherwise,
|
|
this is an indirect operation and the command is stored in the command buffer
|
|
without an I/O operation taking place.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Low-level environment handle</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The low-level environment that the operation applies to. If this parameter
|
|
is omitted or given with a value of zero, the default low-level environment is
|
|
used.</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">CPFA301 E</td>
|
|
<td valign="top">Command buffer is full.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA303 E</td>
|
|
<td valign="top">Error occurred for screen I/O operation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA304 E</td>
|
|
<td valign="top">Data-stream error &1 reported for screen I/O
|
|
operation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA305 E</td>
|
|
<td valign="top">Cannot add operation to command buffer.</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">CPFA308 E</td>
|
|
<td valign="top">Attempt to write data past end of display.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA31D E</td>
|
|
<td valign="top">Attempt to write outside of window area.</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">CPFA331 E</td>
|
|
<td valign="top">Buffer handle incorrect.</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">CPFA334 E</td>
|
|
<td valign="top">Low level environment handle incorrect.</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">CPFA33C E</td>
|
|
<td valign="top">Undefined field ID &1.</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>
|
|
</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>
|
|
|