774 lines
25 KiB
HTML
774 lines
25 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>Set Field with CCSID (QsnSetFldCC) 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. -->
|
||
|
|
<!-- created by Kyle Gilbertson on June 19, 2001 -->
|
||
|
|
<!-- 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>Set Field with CCSID (QsnSetFldCC) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 75%;">
|
||
|
|
<br>
|
||
|
|
Omissible 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%">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" width="10%">2</td>
|
||
|
|
<td align="left" valign="top" width="50%">Field length</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">3</td>
|
||
|
|
<td align="left" valign="top">Display Positions</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">CCSID</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">Row</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">Column</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">Field format word (FFW)</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(2)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">Field control words (FCW)</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">Number of field control words</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">10</td>
|
||
|
|
<td align="left" valign="top">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">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">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">13</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">14</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 Set Field with CCSID (QsnSetFldCC) API defines a CCSID-capable input
|
||
|
|
field on the screen at the given row and column. The following occurs when this
|
||
|
|
command is issued to the control unit as a direct operation or when the buffer
|
||
|
|
containing the command is written out:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>Any outstanding AID requests are cleared.<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>The keyboard is locked.<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>If there is an entry in the format table whose starting address is equal to
|
||
|
|
the address for this field, then that entry is modified. The FFW of the
|
||
|
|
existing entry is replaced by the new FFW and the previous screen starting
|
||
|
|
attribute is overlaid with the new screen starting attribute. The ending screen
|
||
|
|
attribute is not rewritten. All FCWs and the length parameter are ignored. See
|
||
|
|
the 5250 data stream documentation for details.<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>If no entry can be found in the table for the field being defined, a new
|
||
|
|
entry will be added to the end of the table. However, the address must be
|
||
|
|
greater than the ending address of the field currently defined last in the
|
||
|
|
format table or an error will occur. If the new entry is valid, it will contain
|
||
|
|
the field's FFW, the optional FCWs, and the field's starting and ending
|
||
|
|
address. An error will occur if an attempt is made to define too many fields on
|
||
|
|
the screen (see the 5250 data stream documentation for details).</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>The display address after this operation will be the starting field address
|
||
|
|
minus 1 if row and column are specified as valid positive integers or if this
|
||
|
|
is the first field specified within the current WTD command. Otherwise, the
|
||
|
|
display address will be one position past the ending screen attribute.</p>
|
||
|
|
|
||
|
|
<p>This command corresponds indirectly to the 5250 Write to Display (WTD)
|
||
|
|
command with a Set Buffer Address order and a Start of Field order if the row
|
||
|
|
and column parameters are specified. Special FCWs inserted into the data stream
|
||
|
|
by this API to make the field CCSID-capable. (For an indirect operation, a WTD
|
||
|
|
is placed in the command buffer only if one does not already exist in that
|
||
|
|
buffer.)</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Restrictions</h3>
|
||
|
|
|
||
|
|
<p>The same restrictions apply as for the Write Data with CCSID (QsnWrtDtaCC)
|
||
|
|
API, with the exception that the trailing field attribute can be written past
|
||
|
|
the end of the screen. (It will be suppressed by the control unit.)</p>
|
||
|
|
|
||
|
|
<p>This command is not supported by all control units. A CPFA306 error occurs
|
||
|
|
if an attempt is made to issue this command to a control unit that does not
|
||
|
|
support it.</p>
|
||
|
|
|
||
|
|
<p>The CCSID value given must be
|
||
|
|
supported by the device or emulator, otherwise a CPF3BDE will be signaled.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<p>None</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Omissible Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Field ID</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The field ID to be associated with this field. The value specified can be
|
||
|
|
any nonzero integer value. For APIs that accept a field ID parameter, this
|
||
|
|
value can be subsequently used instead of the row and column parameter to
|
||
|
|
specify a screen address. If the given ID is already defined, this operation
|
||
|
|
will redefine that field ID with the values specified. To remove a field ID
|
||
|
|
definition, use the QsnDltFldId API.</p>
|
||
|
|
|
||
|
|
<p>If a previously defined field ID is supplied and some or all of the
|
||
|
|
parameters are omitted, the field is defined using the current field definition
|
||
|
|
values for those omitted parameters.</p>
|
||
|
|
|
||
|
|
<p>If this field is omitted or specified with a value of zero, then no field ID
|
||
|
|
is associated with this field description.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Field length</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The number of bytes that this field being defined contains (a single
|
||
|
|
character might be composed of multiple bytes). If no field ID is specified,
|
||
|
|
the length must be a positive integer value greater than 1 for signed numeric
|
||
|
|
fields and greater than 0 for all other field types. The entire field must fit
|
||
|
|
on the display. If a field ID is specified with a nonzero value, the length may
|
||
|
|
be 0, in which case a field will not be defined on the screen; however, this
|
||
|
|
will associate the field definition with the specified field ID.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Display positions</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The number of positions on the display allowed for this field being defined
|
||
|
|
(a single character may require more than one position on the display).</p>
|
||
|
|
|
||
|
|
<p>If this parameter is not specified, the default is the number given by the
|
||
|
|
field length parameter.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>CCSID</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The CCSID of the data that can be entered into this field. If the CCSID
|
||
|
|
given is not supported by the device, a CPF3BDE is signaled.</p>
|
||
|
|
|
||
|
|
<p>If this parameter is omitted (zero is passed in as the CCSID), and the field
|
||
|
|
ID parameter was omitted or previously undefined, the job CCSID is used. If the
|
||
|
|
job CCSID is 65535, the default job CCSID is used instead.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Row</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The row at which to define the field. 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 <samp>base+offset=actual</samp>. The <samp>base</samp> is the
|
||
|
|
row location of the top window border (0 for full screen) if <samp>
|
||
|
|
offset</samp> is positive, or the row location of the bottom window border
|
||
|
|
(screen height plus 1 for full screen) if <samp>offset</samp> is negative. The
|
||
|
|
<samp>offset</samp> is the row parameter value specified, and <samp>
|
||
|
|
actual</samp> is the actual screen row to be used. A CPFA307 error occurs if an
|
||
|
|
incorrect row value is specified.</p>
|
||
|
|
|
||
|
|
<p>The starting field address will be the row and column locations given if
|
||
|
|
both parameters are specified. Otherwise, it will be the current display
|
||
|
|
address plus 1. 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 initial screen attribute and the field definition. The
|
||
|
|
ending field address for this field is the starting field address plus the
|
||
|
|
number of character positions for the field.</p>
|
||
|
|
|
||
|
|
<p>If a field ID is supplied along with a row and column, the row and column
|
||
|
|
parameters will be stored as specified. These parameters will be used as
|
||
|
|
relative or actual screen positions on a subsequent operation, depending upon
|
||
|
|
the window mode setting for the environment supplied with that operation.</p>
|
||
|
|
|
||
|
|
<p>If a previously undefined field ID is supplied with this operation, the row
|
||
|
|
and column parameters must be specified. Also, the row and column parameters
|
||
|
|
must both be specified or omitted; one cannot be specified if the other is
|
||
|
|
omitted. A CPFA307 error occurs if an incorrect cursor position is specified.
|
||
|
|
On some devices, row and column can both be specified as 1, which will cause
|
||
|
|
the field to be defined at row 1, column 1, with a screen attribute of normal
|
||
|
|
(X'20'). If this is the case, then any initial screen attribute parameters
|
||
|
|
specified are ignored. This is only supported by certain devices. Whether or
|
||
|
|
not this is supported can be determined by the Query 5250 (QsnQry5250) API.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Column</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The column at which to write the data. 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 <samp>base+offset=actual</samp>. The <samp>base</samp> is the
|
||
|
|
column location of the left window border (0 for full screen) if <samp>
|
||
|
|
offset</samp> is positive, or the column location of the right window border
|
||
|
|
(screen width plus 1 for full screen) if <samp>offset</samp> is negative. The
|
||
|
|
<samp>offset</samp> is the column parameter value specified, and <samp>
|
||
|
|
actual</samp> is the actual screen column to be used. A CPFA307 error occurs if
|
||
|
|
an incorrect column value is specified.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Field format word (FFW)</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(2)
|
||
|
|
|
||
|
|
<p>The field format word is a 2-byte value that controls the type of the field
|
||
|
|
being defined. <a href="QsnSetFld.htm#TBLFFW">QsnSetFld Table 6</a> shows the
|
||
|
|
field types, and the corresponding bit to be set for each type. To omit this
|
||
|
|
parameter, specify X'00' in both characters of the parameter. You must specify
|
||
|
|
this parameter to define an input field, and it is required if a field control
|
||
|
|
word is specified.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Field control words (FCW)</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>An array of 2-byte field control words. The field control words are 2-byte
|
||
|
|
values that request certain functions to be performed. <a href="#TBLFCWCC">
|
||
|
|
Table 10</a> shows the valid field control word values, their function, and
|
||
|
|
mnemonics for those values.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> The 5250 CCSID-based I/O specific FCWs are not
|
||
|
|
allowed, because they are implicitly added as part of the QsnSetFldCC
|
||
|
|
operation. If the CCSID-based I/O CCSID or Maximum data length FCWs are given
|
||
|
|
here, a CPFA332 will result. FCWs will not be exhaustivly checked to see if
|
||
|
|
they are formatted correctly or to see if the function requested is valid for
|
||
|
|
the current device. However, some FCWs are checked against the support provided
|
||
|
|
by the device and a CPFA306 signaled if an incompatibility is found. <a href=
|
||
|
|
"#TBLDEVFCWCC">Table 11</a> shows the display capablility and FCW combinations
|
||
|
|
that are valid.</p>
|
||
|
|
|
||
|
|
<p>Errors not found here may be detected and reported when the FCW is required
|
||
|
|
during subsequent command and keystroke processing. See the 5250 data stream
|
||
|
|
documentation for further details about the meaning and use of these
|
||
|
|
functions.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Number of field control words</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The number of control words in the field control word array. Omitting this
|
||
|
|
parameter or specifying it with a value of 0 indicates that no field control
|
||
|
|
words are specified with the FCW parameter. If this parameter is specified with
|
||
|
|
a nonzero value, the FCW parameter is required; if the FCW parameter is
|
||
|
|
omitted, a CPFA31E error is issued.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Monochrome attribute</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(1)
|
||
|
|
|
||
|
|
<p>The initial screen attribute for monochrome displays. A screen attribute is
|
||
|
|
required for defining a field on the screen; if this parameter is omitted and
|
||
|
|
monochrome attributes are to be used, X'20' is assumed. The initial screen
|
||
|
|
attribute is written one position to the left of the starting field address.
|
||
|
|
The ending screen attribute (X'20') is supplied by the controller and written
|
||
|
|
at the end-of-field address plus 1.</p>
|
||
|
|
|
||
|
|
<p>The monochrome attribute and color attribute parameters consist of 1 byte
|
||
|
|
that will be used as the screen attribute 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. See <a href=
|
||
|
|
"dsm1e.htm#HDRSCRATTR">Screen Attribute Characters</a> for a description of the
|
||
|
|
screen attribute values.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Color attribute</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(1)
|
||
|
|
|
||
|
|
<p>The initial screen attribute for color displays. A screen attribute is
|
||
|
|
required for defining a field on the screen; if this parameter is omitted and
|
||
|
|
color attributes are to be used, X'20' is assumed. See <a href=
|
||
|
|
"dsm1e.htm#HDRSCRATTR">Screen Attribute Characters</a> for a description of the
|
||
|
|
screen attribute values.</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
|
||
|
|
starting field address will be the supplied location. 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>Return 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><a name="HDRFCW">Format of the Field Control Word</a></h3>
|
||
|
|
|
||
|
|
<p>The following table explains the valid field control words (FCW) for use
|
||
|
|
with the QsnSetFldCC API.</p>
|
||
|
|
|
||
|
|
<table border width="100%">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="bottom" colspan="3"><em><a name="TBLFCWCC">Field
|
||
|
|
Control Words</a></em></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">FCW Value</th>
|
||
|
|
<th align="left" valign="top">Mnemonic</th>
|
||
|
|
<th align="left" valign="top">Description</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="10%">X'80nn'</td>
|
||
|
|
<td align="left" valign="top" width="30%">QSN_FCW_RESEQ</td>
|
||
|
|
<td align="left" valign="top" width="60%">Entry field resequencing (used in the
|
||
|
|
Read Input Fields (QsnReadInp) and Read Modified Fields (QsnReadMDT) APIs, and
|
||
|
|
so forth). The <em>nn</em> specifies the next entry field in the sequence
|
||
|
|
(<em>nn</em> can be X'00' to X'80'). See <a href="dsm1e.htm#HDRRESEQ">
|
||
|
|
Resequencing</a>.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'8101'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_MSR</td>
|
||
|
|
<td align="left" valign="top">Magnetic stripe reader entry field.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'8102'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_SLP</td>
|
||
|
|
<td align="left" valign="top">Selector light pen entry field.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'8103'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_MSR_SLP</td>
|
||
|
|
<td align="left" valign="top">Magnetic stripe reader and selector light pen
|
||
|
|
entry field.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'8106'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_SLP_SA</td>
|
||
|
|
<td align="left" valign="top">Selector light pen and selectable attention entry
|
||
|
|
field.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'8501'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_FET</td>
|
||
|
|
<td align="left" valign="top">Forward edge trigger entry field. This provides
|
||
|
|
the same function as Auto Enter specified in the FFW, except a unique AID is
|
||
|
|
returned to the host when the field is exited. The state on the Auto Enter flag
|
||
|
|
in the FFW is ignored.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'8601'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_CONT_FIRST</td>
|
||
|
|
<td align="left" valign="top">Continued entry field first segment.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'8602'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_CONT_LAST</td>
|
||
|
|
<td align="left" valign="top">Continued entry field last segment.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'8603'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_CONT_MIDDLE</td>
|
||
|
|
<td align="left" valign="top">Continued entry field middle segment.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'88nn'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_CP</td>
|
||
|
|
<td align="left" valign="top">Cursor progression entry field.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'89nn'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_HL</td>
|
||
|
|
<td align="left" valign="top">Highlighted entry field.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'8Ann'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_PDS</td>
|
||
|
|
<td align="left" valign="top">Pointer device selection entry field.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'B140'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_MOD11</td>
|
||
|
|
<td align="left" valign="top">Self Check Modulus 11 entry field.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">X'B1A0'</td>
|
||
|
|
<td align="left" valign="top">QSN_FCW_MOD10</td>
|
||
|
|
<td align="left" valign="top">Self Check Modulus 10 entry field.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<h3><a name="HDRDEVFCW">Valid Field Control Word and Device Capability
|
||
|
|
Combinations</a></h3>
|
||
|
|
|
||
|
|
<p>The following table explains the field control words (FCW) available for
|
||
|
|
certain capabilities of the device. If one of the FCW values listed is given to
|
||
|
|
QsnSetFldCC and the corresponding device capability is not supported, a CPFA306
|
||
|
|
will result. QsnSetFldCC, however, does not detect all invalid FCW
|
||
|
|
combinations. See the Field control words (FCW) parameter for more
|
||
|
|
information.</p>
|
||
|
|
|
||
|
|
<p>See the <a href="QsnQry5250.htm">QsnQry5250 API</a> to determine the
|
||
|
|
capablilities supported by the current device.</p>
|
||
|
|
|
||
|
|
<table border width="70%">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="bottom" colspan="2"><a name="TBLDEVFCWCC"><em>Valid
|
||
|
|
Field Control Word and Device Capability Combinations</em></a></th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th>FCW Values</th>
|
||
|
|
<th>Display capablility required for FCW to be valid</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="50%">QSN_FCW_CONT_FIRST,<br>
|
||
|
|
QSN_FCW_CONT_MIDDLE,<br>
|
||
|
|
QSN_FCW_CONT_LAST,<br>
|
||
|
|
QSN_FCW_CP,<br>
|
||
|
|
QSN_FCW_HL,<br>
|
||
|
|
QSN_FCW_PDS</td>
|
||
|
|
<td width="50%">ENPTUI</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top" nowrap>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">CPF3BDE E</td>
|
||
|
|
<td valign="top">CCSID &1 not supported by API.</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">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">CPFA306 E</td>
|
||
|
|
<td valign="top">Command not supported by current device.</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">CPFA30A E</td>
|
||
|
|
<td valign="top">Field length &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFA30B E</td>
|
||
|
|
<td valign="top">Invalid starting address for field.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFA30C E</td>
|
||
|
|
<td valign="top">Maximum allowable number of fields exceeded.</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">CPFA30E E</td>
|
||
|
|
<td valign="top">Invalid field format word.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFA314 E</td>
|
||
|
|
<td valign="top">Memory allocation error.</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">CPFA332 E</td>
|
||
|
|
<td valign="top">Incorrect field control word.</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">CPFA33D E</td>
|
||
|
|
<td valign="top">Invalid screen attribute.</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: V5R2
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|