1062 lines
25 KiB
HTML
1062 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>Query 5250 (QsnQry5250) 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>Query 5250 (QsnQry5250) API</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
<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%">Receiver variable</td>
|
|
<td align="left" valign="top" width="20%">Output</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Length of receiver variable</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Omissible Parameter:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">3</td>
|
|
<td align="left" valign="top" width="50%">Error Code</td>
|
|
<td align="left" valign="top" width="20%">I/O</td>
|
|
<td align="left" valign="top" width="20%">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 Query 5250 (QsnQry5250) API is used to retrieve the results of the Query
|
|
5250 command for the current device. The Query 5250 command returns device and
|
|
controller attributes for the current device, such as whether wide mode and
|
|
graphical user interface (GUI) are supported.</p>
|
|
|
|
<br>
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>None</p>
|
|
|
|
<br>
|
|
<h3>Restrictions</h3>
|
|
|
|
<p>This command is not supported by all control units. A query status of 3
|
|
indicates if the query failed.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The receiver variable that is to receive the result of the query. You can
|
|
specify that the size of the area be smaller than the format requested as long
|
|
as you specify the length of the receiver variable parameter correctly. As a
|
|
result, the API returns only the data the area can hold. The format of the data
|
|
returned is shown in <a href="#HDRQRY5250">Format of the Query Data</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable. If the length is larger than the size
|
|
of the receiver variable, the results are unpredictable. The minimum length is
|
|
8 bytes.</p>
|
|
|
|
<p>The API returns as much information as it can fit in this length. If the
|
|
available information is longer, it is truncated. If the available information
|
|
is shorter, the unused output is unchanged; whatever is already stored in that
|
|
space remains there. To determine how much information the API actually returns
|
|
in response to this call, see the bytes returned field. To determine how much
|
|
information the API could return if space were available, see the bytes
|
|
available field.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Omissible Parameter</h3>
|
|
|
|
<dl>
|
|
<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><a name="HDRQRY5250">Format of the Query Data</a></h3>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Bytes returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Query status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">Work station control unit</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">11</td>
|
|
<td align="center" valign="top">B</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Code Level</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="center" valign="top">E</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="center" valign="top">1E</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Work station type code</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">31</td>
|
|
<td align="center" valign="top">1F</td>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Machine type code</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">35</td>
|
|
<td align="center" valign="top">23</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Model number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">38</td>
|
|
<td align="center" valign="top">26</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Keyboard ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">39</td>
|
|
<td align="center" valign="top">27</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Extended keyboard ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">PC keyboard ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">41</td>
|
|
<td align="center" valign="top">29</td>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Serial number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">45</td>
|
|
<td align="center" valign="top">2D</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">Maximum input fields</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">47</td>
|
|
<td align="center" valign="top">2F</td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Control unit customization</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="left" valign="top">CHAR(12)</td>
|
|
<td align="left" valign="top">Device capabilities</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">62</td>
|
|
<td align="center" valign="top">3E</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Grid buffers</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="bottom">63</td>
|
|
<td align="center" valign="bottom">3F</td>
|
|
<td align="left" valign="bottom">CHAR(1)</td>
|
|
<td align="left" valign="bottom">Type of grid line support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">65</td>
|
|
<td align="center" valign="top">41</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Images or faxes</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">66</td>
|
|
<td align="center" valign="top">42</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Image or fax scaling granularity</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">67</td>
|
|
<td align="center" valign="top">43</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Image or fax rotating granularity</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">68</td>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Image or fax support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">69</td>
|
|
<td align="center" valign="top">45</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Invisible tags</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">70</td>
|
|
<td align="center" valign="top">46</td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3>Field Descriptions</h3>
|
|
|
|
<p>Further details on the fields listed can be found in the 5494 Remote Control
|
|
Unit Functions Reference, SC30-3533, manual.</p>
|
|
|
|
<p><strong>Bytes available.</strong> The number of bytes of data available to
|
|
be returned. All available data is returned if enough space is provided.</p>
|
|
|
|
<p><strong>Bytes returned.</strong> The number of bytes of data returned.</p>
|
|
|
|
<p><strong>Code Level.</strong> Identifies the code release level.</p>
|
|
|
|
<p><strong>Control unit customization.</strong> Indicates customization
|
|
parameters for the control unit as:</p>
|
|
|
|
<p>Byte 0</p>
|
|
|
|
<ul>
|
|
<li>Bit 0: Indicates that the iSeries server can send a 5250 WSC Customization
|
|
command when set on</li>
|
|
|
|
<li>Bit 1: Indicates that the iSeries server can send a 5250 Query Station
|
|
State command when set on</li>
|
|
|
|
<li>Bit 2: Indicates that the iSeries server can send a 5250 Workstation
|
|
Customization command to select the SBA code returned in READ commands for
|
|
displays with ideographic extended attributes when set on.</li>
|
|
|
|
<li>Bit 3: Indicates that the 5250 Workstation Customization command may be
|
|
either 6 bytes or greater than 8 bytes in length when set on.</li>
|
|
|
|
<li>Bits 4-7: Reserved</li>
|
|
</ul>
|
|
|
|
<p>Byte 1: Reserved</p>
|
|
|
|
<p><strong>Device capabilities.</strong> Defines the operating capabilities of
|
|
the designated device as:</p>
|
|
|
|
<p>Byte 0</p>
|
|
|
|
<ul>
|
|
<li>Bits 0-1: Indicate Row 1/Column 1 support as:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>B'00'</em></td>
|
|
<td valign="top">No support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'01'</em></td>
|
|
<td valign="top">limited support</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</li>
|
|
|
|
<li>Bit 2: Indicates the Read MDT Alternate command is supported when set
|
|
on</li>
|
|
|
|
<li>Bit 3: Indicates the work station and control unit have PA1 and PA2 support
|
|
when set on</li>
|
|
|
|
<li>Bit 4: Indicates the work station and control unit have PA3 support when
|
|
set on</li>
|
|
|
|
<li>Bit 5: Indicates the work station and control unit have cursor select
|
|
support when set on</li>
|
|
|
|
<li>Bit 6: Indicates the work station and control unit have move cursor order
|
|
support when set on</li>
|
|
|
|
<li>Bit 7: Indicates the Read Modified Immediate Alternate command is supported
|
|
when set on</li>
|
|
</ul>
|
|
|
|
<p>Byte 1--display screen capabilities</p>
|
|
|
|
<ul>
|
|
<li>Bits 0-3: Define screen size as:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>B'0001'</em></td>
|
|
<td valign="top">24 x 80</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'0011'</em></td>
|
|
<td valign="top">24 x 80 or 27 x 132</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</li>
|
|
|
|
<li>Bit 4: Indicates selector light pen (SLP) is supported when set on</li>
|
|
|
|
<li>Bit 5: Indicates magnetic stripe reader (MSR) is supported when set on</li>
|
|
|
|
<li>Bits 6-7: Define color support as:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>B'00'</em></td>
|
|
<td valign="top">Monochrome display</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'01'</em></td>
|
|
<td valign="top">Color support</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>Byte 2</p>
|
|
|
|
<ul>
|
|
<li>Bit 0: Indicates Text Symbols support when set on</li>
|
|
|
|
<li>Bit 1: Indicates work station and control unit have extended primary
|
|
attribute</li>
|
|
|
|
<li>Bits 2-4: Indicate Office Editor/Text support as:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>B'000'</em></td>
|
|
<td valign="top">No Office Editor/Text support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'001'</em></td>
|
|
<td valign="top">single language Office Editor/Text support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'010'</em></td>
|
|
<td valign="top">dual language Office Editor/Text support</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</li>
|
|
|
|
<li>Bit 5: Indicates work station and control unit have extended primary
|
|
attribute support in data processing (DP) mode (WEA order) when set on</li>
|
|
|
|
<li>Bits 6-7: Indicates extended foreground color attribute support<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>B'01'</em></td>
|
|
<td valign="top">Available in DP mode. Fourteen colors are defined, but only
|
|
seven are available. The other seven colors are mapped into the available
|
|
colors.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'10'</em></td>
|
|
<td valign="top">Available in DP mode. Fourteen colors are supported.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>Byte 3</p>
|
|
|
|
<ul>
|
|
<li>Bits 0-2: Indicate ideographic capability as:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>B'000'</em></td>
|
|
<td valign="top">No ideographic capability</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'001'</em></td>
|
|
<td valign="top">Ideographic capability for presentation screen only</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'010'</em></td>
|
|
<td valign="top">Ideographic data type and presentation screen ideographic
|
|
capability</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</li>
|
|
|
|
<li>Bits 3-5: Indicate bidirectional support as:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>B'000'</em></td>
|
|
<td valign="top">No bidirectional capability</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'001'</em></td>
|
|
<td valign="top">Bidirectional capability</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</li>
|
|
|
|
<li>Bit 6: Ideographic</li>
|
|
|
|
<li>Bit 7: Indicates CCSID-based I/O is supported when set on.</li>
|
|
</ul>
|
|
|
|
<p>Byte 4</p>
|
|
|
|
<ul>
|
|
<li>Bits 0-2: Indicate graphics capability as:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>B'000'</em></td>
|
|
<td valign="top">No graphics capability</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'001'</em></td>
|
|
<td valign="top">5292-style graphics</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'010'</em></td>
|
|
<td valign="top">GDDM<sup>(R)</sup>-OS/2<sup>(R)</sup> Link Graphics</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</li>
|
|
|
|
<li>Bit 3: Indicates extended 3270 data stream capability when set on</li>
|
|
|
|
<li>Bit 4: Indicates a pointer device is available when set on</li>
|
|
|
|
<li>Bit 5: Indicates that GUI-like characters are available when set on</li>
|
|
|
|
<li>Bit 6: Indicates the control unit supports enhanced user interface commands
|
|
and field control words (FCWs) when set on.
|
|
|
|
<p>The commands include:</p>
|
|
|
|
<blockquote>
|
|
<p>Create Window</p>
|
|
|
|
<p>Unrestricted Cursor Movement</p>
|
|
|
|
<p>Remove GUI Window</p>
|
|
|
|
<p>Remove All GUI Constructs</p>
|
|
|
|
<p>Read Screen To Print</p>
|
|
|
|
<p>Read Screen To Print With Extended Attributes</p>
|
|
|
|
<p>Write Error Code To Window</p>
|
|
|
|
<p>Save Partial Screen</p>
|
|
|
|
<p>Restore Partial Screen</p>
|
|
|
|
<p>Define Selection Field</p>
|
|
|
|
<p>Remove GUI Selection Field</p>
|
|
|
|
<p>Define Scroll Bar</p>
|
|
|
|
<p>Remove GUI Scroll Bar</p>
|
|
</blockquote>
|
|
|
|
<p>The FCWs include:</p>
|
|
|
|
<blockquote>
|
|
<p>Continued</p>
|
|
|
|
<p>Cursor Progression</p>
|
|
|
|
<p>Highlighted</p>
|
|
|
|
<p>Pointer Device Selection</p>
|
|
</blockquote>
|
|
</li>
|
|
|
|
<li>Bit 7: Indicates Write Error Code To Window command is supported when set
|
|
on</li>
|
|
</ul>
|
|
|
|
<p>Byte 5</p>
|
|
|
|
<ul>
|
|
<li>Bit 0: Indicates the Write Data and Programmable Mouse Buttons structured
|
|
field commands, the Word Wrap FCW, and Ideographic Continued entry fields are
|
|
supported when set on</li>
|
|
|
|
<li>Bit 1: Indicates this is a GUI device which will use all-points-addressable
|
|
constructs for windows, selection fields, and scroll bars, when set on</li>
|
|
|
|
<li>Bits 2-7: Reserved</li>
|
|
</ul>
|
|
|
|
<p>Byte 6: Reserved</p>
|
|
|
|
<p>Bytes 7-8:</p>
|
|
|
|
<ul>
|
|
<li>Bit 0-13: Reserved</li>
|
|
|
|
<li>Bit 14-15: 5250 fax or image support<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>B'00'</em></td>
|
|
<td valign="top">No 5250 image or fax support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'01'</em></td>
|
|
<td valign="top">Support for seven formats:<br>
|
|
<ul>
|
|
<li>TIFF
|
|
|
|
<ul>
|
|
<li>No compression</li>
|
|
|
|
<li>CCITT Group 3 fax one-dimensional, modified-Huffman run-length
|
|
encoding</li>
|
|
|
|
<li>CCITT Group 3 fax compression</li>
|
|
|
|
<li>CCITT Group 4 fax compression</li>
|
|
|
|
<li>PackBits run-length encoding</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>PCX monochrome format</li>
|
|
|
|
<li>Stand-alone CCITT Group 3 fax compression</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'11'</em></td>
|
|
<td valign="top">Support for the seven previous formats, plus five additional
|
|
formats:<br>
|
|
<ul>
|
|
<li>IOCA
|
|
|
|
<ul>
|
|
<li>IBM MMR algorithm</li>
|
|
|
|
<li>No compression</li>
|
|
|
|
<li>CCITT Group 3 fax one-dimensional, modified-Huffman run-length
|
|
encoding</li>
|
|
|
|
<li>CCITT Group 3 fax compression</li>
|
|
|
|
<li>CCITT Group 4 fax compression</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>Byte 9: Reserved for use by PC emulators to indicate additional 5250 image
|
|
or fax formats supported</p>
|
|
|
|
<p>Byte 10:</p>
|
|
|
|
<ul>
|
|
<li>Bit 0: Indicates printer type as:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>B'0'</em></td>
|
|
<td valign="top">SCS printer</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'1'</em></td>
|
|
<td valign="top">IPDS printer</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</li>
|
|
|
|
<li>Bits 1-7: Reserved</li>
|
|
</ul>
|
|
|
|
<p>Byte 11: Reserved</p>
|
|
|
|
<p><strong>Extended keyboard ID.</strong> The device code for extended 5250
|
|
keyboards.</p>
|
|
|
|
<p><strong>Grid buffers.</strong> The number of grid buffers that are available
|
|
in the device.</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>X'00'</em></td>
|
|
<td valign="top">Not grid-capable.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Images or faxes.</strong> The number of images or faxes that can be
|
|
presented on a display screen.</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>X'00'</em></td>
|
|
<td valign="top">No 5250 image or fax support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'01-FE'</em></td>
|
|
<td valign="top">Number allowed</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'FF'</em></td>
|
|
<td valign="top">Variable, dependent on the size of the image or fax</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Image or fax scaling granularity.</strong></p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>X'00'</em></td>
|
|
<td valign="top">No 5250 image or fax support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Support for scaling percentages from 3% to 400%. No scroll-bar
|
|
scaling, fill scaling, no change scaling, increment and decrement</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'02-7E'</em></td>
|
|
<td valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'7F'</em></td>
|
|
<td valign="top">Support for continuous scaling</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'80-FF'</em></td>
|
|
<td valign="top">Reserved for use by 5250 PWS emulators</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Image or fax rotating granularity.</strong></p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>X'00'</em></td>
|
|
<td valign="top">No 5250 image or fax support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Support for rotating of 0, 90, 180, and 270 degrees</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'02-7E'</em></td>
|
|
<td valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'7F'</em></td>
|
|
<td valign="top">Support for continuous rotation</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'80-FF'</em></td>
|
|
<td valign="top">Reserved for use by 5250 PWS emulators</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>Image or fax support.</strong></p>
|
|
|
|
<table width="80%">
|
|
<tr>
|
|
<td width="15%" valign="top"><em>X'00'</em></td>
|
|
<td width="85%" valign="top">No 5250 image or fax support
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td valign="top"><em>B'0'</em></td>
|
|
<td valign="top">Pop-up and pull-down windows that were written
|
|
after image or fax are presented over image or fax data when set on</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'1'</em></td>
|
|
<td valign="top">This device supports transparent mode.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>B'2-7'</em></td>
|
|
<td valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Invisible tags.</strong> Defines more device capabilities of the
|
|
designated device as:</p>
|
|
|
|
<ul>
|
|
<li>Bits 0-5: Reserved</li>
|
|
|
|
<li>Bit 6: EBCDIC-to-ASCII translation. This is used by workstation gateway
|
|
devices.</li>
|
|
|
|
<li>Bit 7: True transparency.</li>
|
|
</ul>
|
|
|
|
<p><strong>Keyboard ID.</strong> Reserved. This field is set to X'00'.</p>
|
|
|
|
<p><strong>Machine type code.</strong> An EBCDIC code for the machine type.</p>
|
|
|
|
<p><strong>Maximum input fields.</strong> The maximum number of input fields
|
|
available (256).</p>
|
|
|
|
<p><strong>Model number.</strong> An EBCDIC code for the machine model
|
|
number.</p>
|
|
|
|
<p><strong>PC keyboard ID.</strong> Device code for PC keyboards attached to a
|
|
5250 work station (X'00' for nonprogrammable work stations).</p>
|
|
|
|
<p><strong>Query status.</strong> The status of the 5250 query data. The
|
|
possible values are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="30 70" -->
|
|
<tr>
|
|
<td valign="top" nowrap><em>DSM_5250Q_YES (1)</em></td>
|
|
<td valign="top">Query information successfully retrieved.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>DSM_5250Q_NO (2)</em></td>
|
|
<td valign="top">Query cannot be issued for the device. This occurs when the
|
|
device configuration specifies that the query command should not be issued
|
|
against the device.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>DSM_5250Q_FAIL (3)</em></td>
|
|
<td valign="top">Query command failed. Default values are supplied based on the
|
|
device type. This occurs, for example, when the controller does not support the
|
|
query command.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>Serial number.</strong> Field for device serial number. This field
|
|
is set to zero for a work station with no serial number.</p>
|
|
|
|
<p><strong>Type of grid line support.</strong></p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>X'00'</em></td>
|
|
<td valign="top">No grid line support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Type 1 grid line support including support for grid line
|
|
commands</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Work station control unit.</strong> The type of control unit.</p>
|
|
|
|
<p><strong>Work station type code.</strong> The workstation type. The value is
|
|
X'01' for display station.</p>
|
|
|
|
<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">CPF3C24 E</td>
|
|
<td valign="top">Length of the receiver variable is not valid.</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">CPFA31E E</td>
|
|
<td valign="top">Required parameter &1 omitted.</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>
|
|
|