friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QGYRPRTA.htm

1698 lines
43 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>Retrieve Printer Attributes (QGYRPRTA) 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. -->
<!-- Print SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited by Kersten Oct 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>Retrieve Printer Attributes (QGYRPRTA) API</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;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>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Device name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Retrieve Printer Attributes (QGYRPRTA) API retrieves attributes about a
specific printer device. The output returned varies depending on whether the
writer is started or not.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The receiver variable that receives the information requested. You can
specify the size of the area to be smaller than the format requested as long as
you specify the length parameter correctly. As a result, the API returns only
the data that the area can hold.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable provided. The length of receiver
variable parameter may be specified up to the size of the receiver variable
specified in the user program. If the length of receiver variable parameter
specified is larger than the allocated size of the receiver variable specified
in the user program, the results are not predictable. The minimum length is 8
bytes.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the printer attributes being returned. The valid format is
RPTA0100.</p>
</dd>
<dt><strong>Device name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the printer device for which information should be
retrieved.</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>.</p>
</dd>
</dl>
<br>
<h3>Format of Receiver Variable</h3>
<p>The following table describes the order and format of the data that is
returned in the receiver variable.</p>
<br>
<h3><a name="HDRGHIZ">RPTA0100 Format</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="top" 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(10)</td>
<td align="left" valign="top">Device name</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Writer started</td>
</tr>
<tr>
<td align="center" valign="top">19</td>
<td align="center" valign="top">13</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Writer status</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BIN(4)</td>
<td align="left" valign="top">Device status</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BIN(4)</td>
<td align="left" valign="top">Overall status</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">78</td>
<td align="center" valign="top">4E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Started by user</td>
</tr>
<tr>
<td align="center" valign="top">90</td>
<td align="center" valign="top">5A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Writing status</td>
</tr>
<tr>
<td align="center" valign="top">91</td>
<td align="center" valign="top">5B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Waiting for message status</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Held status</td>
</tr>
<tr>
<td align="center" valign="top">93</td>
<td align="center" valign="top">5D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">End pending status</td>
</tr>
<tr>
<td align="center" valign="top">94</td>
<td align="center" valign="top">5E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Hold pending status</td>
</tr>
<tr>
<td align="center" valign="top">95</td>
<td align="center" valign="top">5F</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Between files status</td>
</tr>
<tr>
<td align="center" valign="top">96</td>
<td align="center" valign="top">60</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Between copies status</td>
</tr>
<tr>
<td align="center" valign="top">97</td>
<td align="center" valign="top">61</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Waiting for data status</td>
</tr>
<tr>
<td align="center" valign="top">98</td>
<td align="center" valign="top">62</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Waiting for device status</td>
</tr>
<tr>
<td align="center" valign="top">99</td>
<td align="center" valign="top">63</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">On job queue status</td>
</tr>
<tr>
<td align="center" valign="top">100</td>
<td align="center" valign="top">64</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Writer job name</td>
</tr>
<tr>
<td align="center" valign="top">114</td>
<td align="center" valign="top">72</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Writer job user name</td>
</tr>
<tr>
<td align="center" valign="top">124</td>
<td align="center" valign="top">7C</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Writer job number</td>
</tr>
<tr>
<td align="center" valign="top">130</td>
<td align="center" valign="top">82</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Printer device type</td>
</tr>
<tr>
<td align="center" valign="top">140</td>
<td align="center" valign="top">8C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of separators</td>
</tr>
<tr>
<td align="center" valign="top">144</td>
<td align="center" valign="top">90</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Drawer for separators</td>
</tr>
<tr>
<td align="center" valign="top">148</td>
<td align="center" valign="top">94</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Align forms</td>
</tr>
<tr>
<td align="center" valign="top">158</td>
<td align="center" valign="top">9E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Output queue name</td>
</tr>
<tr>
<td align="center" valign="top">168</td>
<td align="center" valign="top">A8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Output queue library name</td>
</tr>
<tr>
<td align="center" valign="top">178</td>
<td align="center" valign="top">B2</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Output queue status</td>
</tr>
<tr>
<td align="center" valign="top">179</td>
<td align="center" valign="top">B3</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Network directory publishing status</td>
</tr>
<tr>
<td align="center" valign="top">179</td>
<td align="center" valign="top">B3</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">180</td>
<td align="center" valign="top">B4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Form type</td>
</tr>
<tr>
<td align="center" valign="top">190</td>
<td align="center" valign="top">BE</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message option</td>
</tr>
<tr>
<td align="center" valign="top">200</td>
<td align="center" valign="top">C8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Automatically end writer</td>
</tr>
<tr>
<td align="center" valign="top">210</td>
<td align="center" valign="top">D2</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Allow direct printing</td>
</tr>
<tr>
<td align="center" valign="top">220</td>
<td align="center" valign="top">DC</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message queue name</td>
</tr>
<tr>
<td align="center" valign="top">230</td>
<td align="center" valign="top">E6</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message queue library name</td>
</tr>
<tr>
<td align="center" valign="top">240</td>
<td align="center" valign="top">F0</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">242</td>
<td align="center" valign="top">F2</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Changes take effect</td>
</tr>
<tr>
<td align="center" valign="top">252</td>
<td align="center" valign="top">FC</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Next output queue name</td>
</tr>
<tr>
<td align="center" valign="top">262</td>
<td align="center" valign="top">106</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Next output queue library name</td>
</tr>
<tr>
<td align="center" valign="top">272</td>
<td align="center" valign="top">110</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Next form type</td>
</tr>
<tr>
<td align="center" valign="top">282</td>
<td align="center" valign="top">11A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Next message option</td>
</tr>
<tr>
<td align="center" valign="top">292</td>
<td align="center" valign="top">124</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Next file separators</td>
</tr>
<tr>
<td align="center" valign="top">296</td>
<td align="center" valign="top">128</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Next separator drawer</td>
</tr>
<tr>
<td align="center" valign="top">300</td>
<td align="center" valign="top">12C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Spooled file name</td>
</tr>
<tr>
<td align="center" valign="top">310</td>
<td align="center" valign="top">136</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job name</td>
</tr>
<tr>
<td align="center" valign="top">320</td>
<td align="center" valign="top">140</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User name</td>
</tr>
<tr>
<td align="center" valign="top">330</td>
<td align="center" valign="top">14A</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Job number</td>
</tr>
<tr>
<td align="center" valign="top">336</td>
<td align="center" valign="top">150</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Spooled file number</td>
</tr>
<tr>
<td align="center" valign="top">340</td>
<td align="center" valign="top">154</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Page being written</td>
</tr>
<tr>
<td align="center" valign="top">344</td>
<td align="center" valign="top">158</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Total pages</td>
</tr>
<tr>
<td align="center" valign="top">348</td>
<td align="center" valign="top">15C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Copies left to produce</td>
</tr>
<tr>
<td align="center" valign="top">352</td>
<td align="center" valign="top">160</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Total copies</td>
</tr>
<tr>
<td align="center" valign="top">356</td>
<td align="center" valign="top">164</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Advanced Function Printing</td>
</tr>
<tr>
<td align="center" valign="top">366</td>
<td align="center" valign="top">16E</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Message key</td>
</tr>
<tr>
<td align="center" valign="top">370</td>
<td align="center" valign="top">172</td>
<td align="left" valign="top">CHAR(11)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">381</td>
<td align="center" valign="top">17D</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Job system name</td>
</tr>
<tr>
<td align="center" valign="top">389</td>
<td align="center" valign="top">185</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Spooled file create date</td>
</tr>
<tr>
<td align="center" valign="top">396</td>
<td align="center" valign="top">18C</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Spooled file create time</td>
</tr>
</table>
<br>
<h3><a name="HDRPRTW100">Field Descriptions</a></h3>
<p><strong>Advanced Function Printing.</strong> Whether the printer supports
Advanced Function Printing.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">Advanced Function Printing is not supported</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">Advanced Function Printing is supported</td>
</tr>
</table>
<br>
<p><strong>Align forms.</strong> The time at which the forms alignment message
will be sent.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*WTR</em></td>
<td align="left" valign="top">The writer determines when the message is sent.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FILE</em></td>
<td align="left" valign="top">Control of the page alignment is specified by each file.</td>
</tr>
</table>
<br>
<p><strong>Allow direct printing.</strong> Whether the printer writer allows
the printer to be allocated to a job that prints directly to a printer.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">Direct printing is not allowed</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">Direct printing is allowed.</td>
</tr>
</table>
<br>
<p><strong>Automatically end writer.</strong> When to end the writer if it is
to end automatically.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NORDYF</em></td>
<td align="left" valign="top">When no files are ready to print on the output queue from
which the writer is selecting files to be printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FILEEND</em></td>
<td align="left" valign="top">When the current spooled file has been printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">The writer will not end, but it will wait for more spooled
files.</td>
</tr>
</table>
<br>
<p><strong>Between copies status.</strong> Whether the writer is between copies
of a multiple copy spooled file. The possible values are Y (yes) or N (no).</p>
<p><strong>Between files status.</strong> Whether the writer is between spooled
files. The possible values are Y (yes) or N (no).</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>Changes take effect.</strong> The time at which the pending changes
to the writer take effect.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NORDYF</em></td>
<td align="left" valign="top">When all the current eligible files are printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FILEEND</em></td>
<td align="left" valign="top">When the current spooled file is done printing.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Blank</em></td>
<td align="left" valign="top">No pending changes to the writer.</td>
</tr>
</table>
<br>
<p><strong>Copies left to produce.</strong> The number of copies left to be
printed. This field is set to 0 when no file is printing.</p>
<p><strong>Device name.</strong> The name of the printer device.</p>
<p><strong>Device status.</strong> The status of the printer device.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Status Numeric Code (decimal)</th>
<th align="left" valign="top">Overall Status</th>
</tr>
<tr>
<td align="left" valign="top">0</td>
<td align="left" valign="top">VARIED OFF</td>
</tr>
<tr>
<td align="left" valign="top">5</td>
<td align="left" valign="top">AS/36 DISABLED</td>
</tr>
<tr>
<td align="left" valign="top">10</td>
<td align="left" valign="top">VARY OFF PENDING</td>
</tr>
<tr>
<td align="left" valign="top">20</td>
<td align="left" valign="top">VARY ON PENDING</td>
</tr>
<tr>
<td align="left" valign="top">30</td>
<td align="left" valign="top">VARIED ON</td>
</tr>
<tr>
<td align="left" valign="top">40</td>
<td align="left" valign="top">CONNECT PENDING</td>
</tr>
<tr>
<td align="left" valign="top">50</td>
<td align="left" valign="top">SIGNON DISPLAY</td>
</tr>
<tr>
<td align="left" valign="top">60</td>
<td align="left" valign="top">ACTIVE</td>
</tr>
<tr>
<td align="left" valign="top">62</td>
<td align="left" valign="top">AS/36 ENABLED</td>
</tr>
<tr>
<td align="left" valign="top">63</td>
<td align="left" valign="top">ACTIVE READER</td>
</tr>
<tr>
<td align="left" valign="top">66</td>
<td align="left" valign="top">ACTIVE WRITER</td>
</tr>
<tr>
<td align="left" valign="top">70</td>
<td align="left" valign="top">HELD</td>
</tr>
<tr>
<td align="left" valign="top">75</td>
<td align="left" valign="top">POWERED OFF</td>
</tr>
<tr>
<td align="left" valign="top">80</td>
<td align="left" valign="top">RCYPND</td>
</tr>
<tr>
<td align="left" valign="top">90</td>
<td align="left" valign="top">RCYCNL</td>
</tr>
<tr>
<td align="left" valign="top">95</td>
<td align="left" valign="top">SYSTEM REQUEST</td>
</tr>
<tr>
<td align="left" valign="top">100</td>
<td align="left" valign="top">FAILED</td>
</tr>
<tr>
<td align="left" valign="top">103</td>
<td align="left" valign="top">FAILED READER</td>
</tr>
<tr>
<td align="left" valign="top">106</td>
<td align="left" valign="top">FAILED WRITER</td>
</tr>
<tr>
<td align="left" valign="top">110</td>
<td align="left" valign="top">DIAGNOSTIC MODE</td>
</tr>
<tr>
<td align="left" valign="top">111</td>
<td align="left" valign="top">DAMAGED</td>
</tr>
<tr>
<td align="left" valign="top">112</td>
<td align="left" valign="top">LOCKED</td>
</tr>
<tr>
<td align="left" valign="top">113</td>
<td align="left" valign="top">UNKNOWN</td>
</tr>
</table>
<p><strong>Note:</strong> Not all of the values apply to printer devices.</p>
<br>
<p><strong>Drawer for separators.</strong> The drawer from which the job and
file separator pages are to be taken.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top" nowrap>-1</td>
<td align="left" valign="top">*FILE: The separator page prints from the same drawer that the
file is printed from. If you specify a drawer different from the file that
contains colored or different type paper, the page separator is more
identifiable.</td>
</tr>
<tr>
<td align="left" valign="top">-2</td>
<td align="left" valign="top">*DEVD: The separator pages will print from the separator
drawer specified in the printer device description.</td>
</tr>
<tr>
<td align="left" valign="top">1</td>
<td align="left" valign="top">The first drawer.</td>
</tr>
<tr>
<td align="left" valign="top">2</td>
<td align="left" valign="top">The second drawer.</td>
</tr>
<tr>
<td align="left" valign="top">3</td>
<td align="left" valign="top">The third drawer.</td>
</tr>
</table>
<br>
<p><strong>End pending status.</strong> Whether an End Writer (ENDWTR) command
has been issued for this writer.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">No ENDWTR command was issued.</td>
</tr>
<tr>
<td align="left" valign="top"><em>I</em></td>
<td align="left" valign="top">*IMMED: The writer ends as soon as its output buffers are
empty.</td>
</tr>
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">*CNTRLD: The writer ends after the current copy of the spooled
file has been printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>P</em></td>
<td align="left" valign="top">*PAGEEND: The writer ends at the end of the page.</td>
</tr>
</table>
<br>
<p><strong>Form type.</strong> The type of form being used to print the spooled
file.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The writer is started with the option to print all spooled
files of any form type.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FORMS</em></td>
<td align="left" valign="top">The writer is started with the option to print all the spooled
files with the same form type before using a different form type.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*STD</em></td>
<td align="left" valign="top">The writer is started with the option to print all the spooled
files with a form type of *STD.</td>
</tr>
<tr>
<td align="left" valign="top"><em>form type name</em></td>
<td align="left" valign="top">The writer is started with the option to print all the spooled
files with the form type you specified.</td>
</tr>
</table>
<br>
<p><strong>Held status.</strong> Whether the writer is held. The possible
values are Y (yes) or N (no).</p>
<p><strong>Hold pending status.</strong> Whether a Hold Writer (HLDWTR) command
has been issued for this writer.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">No HLDWTR command was issued.</td>
</tr>
<tr>
<td align="left" valign="top"><em>I</em></td>
<td align="left" valign="top">*IMMED: The writer is held as soon as its output buffers are
empty.</td>
</tr>
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">*CNTRLD: The writer is held after the current copy of the file
has been printed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>P</em></td>
<td align="left" valign="top">*PAGEEND: The writer is held at the end of the page.</td>
</tr>
</table>
<br>
<p><strong>Job name.</strong> The name of the job that owns the spooled file
currently being processed by the writer. This field is blank when no spooled
file is printing.</p>
<p><strong>Job number.</strong> The number of the job that owns the spooled
file currently being processed by the writer. This field is blank when no
spooled file is printing.</p>
<p><strong>Job system
name.</strong> The name of the system where the job that created the spooled
file ran. This field is blank when no spooled file is printing.</p>
<p><strong>Message key.</strong> The key to the message that the writer is
waiting for a reply. This field will be blank when the writer is not waiting
for a reply to an inquiry message.</p>
<p><strong>Message option.</strong> A message option for sending a message to
the message queue when this form is finished.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*MSG</em></td>
<td align="left" valign="top">A message is sent to the message queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NOMSG</em></td>
<td align="left" valign="top">No message is sent to the message queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INFOMSG</em></td>
<td align="left" valign="top">An informational message is sent to the message queue.</td>
</tr>
<tr>
<td valign="top"><em>*INQMSG</em></td>
<td valign="top">An inquiry message is sent to the message queue.</td>
</tr>
</table>
<br>
<p><strong>Message queue library name.</strong> The name of the library that
contains the message queue.</p>
<p><strong>Message queue name.</strong> The name of the message queue that this
writer uses for operational messages.</p>
<p><strong>Network directory publishing status.</strong> Whether the printer is
published in the network directory.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Printer is not published</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Printer is published</td>
</tr>
</table>
<p><strong>Next file separators.</strong> The next number of separator pages to
be printed when the change to the writer takes place.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">*FILE: The number of separator pages is specified by each
file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-10</em></td>
<td align="left" valign="top">No pending change to the writer.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Number of separators</em></td>
<td align="left" valign="top">The number of separator pages to be printed.</td>
</tr>
</table>
<br>
<p><strong>Next form type.</strong> The name of the next form type to be
printed.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The writer is changed with the option to print all spooled
files of any form type.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FORMS</em></td>
<td align="left" valign="top">The writer is changed with the option to print all the spooled
files with the same form type before using a different form type.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*STD</em></td>
<td align="left" valign="top">The writer is changed with the option to print all the spooled
files with a form type of *STD.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Form type name</em></td>
<td align="left" valign="top">The writer is changed with the option to print all the spooled
files with the form type name you specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Blank</em></td>
<td align="left" valign="top">No change has been made to this writer.</td>
</tr>
</table>
<br>
<p><strong>Next message option.</strong> The message option for sending a
message to the message queue when the next form type is finished.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*MSG</em></td>
<td align="left" valign="top">A message is sent to the message queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NOMSG</em></td>
<td align="left" valign="top">No message is sent to the message queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INFOMSG</em></td>
<td align="left" valign="top">An informational message is sent to the message queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INQMSG</em></td>
<td align="left" valign="top">An inquiry message is sent to the message queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Blank</em></td>
<td align="left" valign="top">No change pending.</td>
</tr>
</table>
<br>
<p><strong>Next output queue library name.</strong> The name of the library
that contains the next output queue. This field is blank if no changes have
been made to the writer.</p>
<p><strong>Next output queue name.</strong> The name of the next output queue
to be processed. This field is blank if no changes have been made to the
writer.</p>
<p><strong>Next separator drawer.</strong> This value indicates the drawer from
which to take the separator pages if there is a change to the writer.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top">-1</td>
<td align="left" valign="top">*FILE: Separator pages print from the same drawer that the
spooled file prints from. If you specify a drawer different from the spooled
file that contains colored or different type paper, the page separator is more
identifiable.</td>
</tr>
<tr>
<td align="left" valign="top">-2</td>
<td align="left" valign="top">*DEVD: Separator pages print from the separator
drawer specified in the printer device description.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap>-10</td>
<td align="left" valign="top">No pending change to the writer.</td>
</tr>
<tr>
<td align="left" valign="top">1</td>
<td align="left" valign="top">The first drawer.</td>
</tr>
<tr>
<td align="left" valign="top">2</td>
<td align="left" valign="top">The second drawer.</td>
</tr>
<tr>
<td align="left" valign="top">3</td>
<td align="left" valign="top">The third drawer.</td>
</tr>
</table>
<br>
<p><strong>Number of separators.</strong> The number of separator pages to be
printed.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">*FILE: The number of separator pages is specified by each
file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Number of separators</em></td>
<td align="left" valign="top">The number of separator pages to be printed.</td>
</tr>
</table>
<br>
<p><strong>On job queue status.</strong> Whether the writer is on a job queue
and, therefore, is not currently running. The possible values are Y (yes) or N
(no).</p>
<p><strong>Output queue library name.</strong> The name of the library that
contains the output queue from which spooled files are selected for
printing.</p>
<p><strong>Output queue name.</strong> The name of the output queue from which
spooled files are being selected for printing.</p>
<p><strong>Output queue status.</strong> The status of the output queue from
which spooled files are being selected for printing.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>H</em></td>
<td align="left" valign="top">The output queue is held.</td>
</tr>
<tr>
<td align="left" valign="top"><em>R</em></td>
<td align="left" valign="top">The output queue is released.</td>
</tr>
</table>
<br>
<p><strong>Overall status.</strong> The overall status of the logical
printer.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top">1</td>
<td align="left" valign="top">Unavailable</td>
</tr>
<tr>
<td align="left" valign="top">2</td>
<td align="left" valign="top">Powered off or not yet available</td>
</tr>
<tr>
<td align="left" valign="top">3</td>
<td align="left" valign="top">Stopped</td>
</tr>
<tr>
<td align="left" valign="top">4</td>
<td align="left" valign="top">Message waiting</td>
</tr>
<tr>
<td align="left" valign="top">5</td>
<td align="left" valign="top">Held</td>
</tr>
<tr>
<td align="left" valign="top">6</td>
<td align="left" valign="top">Stop (pending)</td>
</tr>
<tr>
<td align="left" valign="top">7</td>
<td align="left" valign="top">Hold (pending)</td>
</tr>
<tr>
<td align="left" valign="top">8</td>
<td align="left" valign="top">Waiting for printer</td>
</tr>
<tr>
<td align="left" valign="top">9</td>
<td align="left" valign="top">Waiting to start</td>
</tr>
<tr>
<td align="left" valign="top">10</td>
<td align="left" valign="top">Printing</td>
</tr>
<tr>
<td align="left" valign="top">11</td>
<td align="left" valign="top">Waiting for printer output</td>
</tr>
<tr>
<td align="left" valign="top">12</td>
<td align="left" valign="top">Connect pending</td>
</tr>
<tr>
<td align="left" valign="top">13</td>
<td align="left" valign="top">Powered off</td>
</tr>
<tr>
<td align="left" valign="top">14</td>
<td align="left" valign="top">Unusable</td>
</tr>
<tr>
<td align="left" valign="top">15</td>
<td align="left" valign="top">Being serviced</td>
</tr>
<tr>
<td align="left" valign="top">999</td>
<td align="left" valign="top">Unknown</td>
</tr>
</table>
<br>
<p><strong>Page being written.</strong> The page number in the spooled file
that is currently being processed by the writer. The page number shown may be
lower or higher than the actual page number being printed because of buffering
done by the system. This field is set to 0 when no spooled file is
printing.</p>
<p><strong>Printer device type.</strong> The type of the printer being used to
print the spooled file.</p>
<p>Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SCS</em></td>
<td align="left" valign="top">SNA (Systems Network Architecture) character string</td>
</tr>
<tr>
<td align="left" valign="top"><em>*IPDS<sup>(TM)</sup></em></td>
<td align="left" valign="top">Intelligent Printer Data Stream<sup>(TM)</sup></td>
</tr>
</table>
<br>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Spooled file create
date.</strong> The date the spooled file was created on the system. The date is
in the CYYMMDD format as follows:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">Century, where 0 indicates years 19<em>xx</em> and 1 indicates years
20<em>xx</em>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>YY</em></td>
<td align="left" valign="top">Year</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Month</td>
</tr>
<tr>
<td align="left" valign="top"><em>DD</em></td>
<td align="left" valign="top">Day</td>
</tr>
</table>
<br>
<p>This field is blank when no spooled file is printing.</p>
<p><strong>Spooled file create time</strong> The time the spooled file was
created on the system. The time is in the HHMMSS format where:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>HH</em></td>
<td align="left" valign="top">Hour</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Minutes</td>
</tr>
<tr>
<td align="left" valign="top"><em>SS</em></td>
<td align="left" valign="top">Seconds</td>
</tr>
</table>
<br>
<p> This field is blank when no spooled file is printing.</p>
<p><strong>Spooled file name.</strong> The name of the spooled file currently
being processed by the writer. This field is blank when no spooled file is
printing.</p>
<p><strong>Spooled file number.</strong> The number of the spooled file
currently being processed by the writer. This field is set to 0 when no spooled
file is printing.</p>
<p><strong>Started by user.</strong> The name of the user that started the
writer.</p>
<p><strong>Text description.</strong> The text description of the printer
device.</p>
<p><strong>Total copies.</strong> The total number of copies to be printed.</p>
<p><strong>Total pages.</strong> The total number of pages in the spooled
file.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>Number</em></td>
<td align="left" valign="top">The number of pages in the spooled file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No spooled file is printing.</td>
</tr>
</table>
<br>
<p><strong>User name.</strong> The name of the user who owns the spooled
file currently being processed by the writer. This field is blank when no file
is printing.</p>
<p><strong>Waiting for data status.</strong> Whether the writer has written all
the data currently in the spooled file and is waiting for more data.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">The writer is not waiting for more data.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Y</em></td>
<td align="left" valign="top">The writer has written all the data currently in the spooled
file and is waiting for more data. This condition occurs when the writer is
producing an open spooled file with SCHEDULE(*IMMED) specified.</td>
</tr>
</table>
<br>
<p><strong>Waiting for device status.</strong> Whether the writer is waiting to
get the device from a job that is printing directly to the printer.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">The writer is not waiting for the device.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Y</em></td>
<td align="left" valign="top">The writer is waiting for the device</td>
</tr>
</table>
<br>
<p><strong>Waiting for message status.</strong> Whether the writer is waiting
for a reply to an inquiry message. The possible values are Y (yes) or N
(no).</p>
<p><strong>Writer job name.</strong> The job name of the printer writer.</p>
<p><strong>Writer job number.</strong> The job number of the printer
writer.</p>
<p><strong>Writer job user name.</strong> The name of the system user.</p>
<p><strong>Writer started.</strong> Whether or not a writer is started for this
printer.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No writer is started</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Writer is started</td>
</tr>
</table>
<br>
<p><strong>Writer status.</strong> The status of the writer for this
printer.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top">X'01'</td>
<td align="left" valign="top">Started</td>
</tr>
<tr>
<td align="left" valign="top">X'02'</td>
<td align="left" valign="top">Ended</td>
</tr>
<tr>
<td align="left" valign="top">X'03'</td>
<td align="left" valign="top">On job queue</td>
</tr>
<tr>
<td align="left" valign="top">X'04'</td>
<td align="left" valign="top">Held</td>
</tr>
<tr>
<td align="left" valign="top">X'05'</td>
<td align="left" valign="top">Message waiting</td>
</tr>
</table>
<br>
<p><strong>Writing status.</strong> Whether the printer writer is in writing
status.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>Y</em></td>
<td valign="top">The writer is in writing status.</td>
</tr>
<tr>
<td valign="top"><em>N</em></td>
<td valign="top">The writer is not in writing status.</td>
</tr>
<tr>
<td valign="top"><em>S</em></td>
<td valign="top">The writer is writing the file separators.</td>
</tr>
</table>
<br>
<h3>Error Messages</h3>
<table 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">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</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">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3313 E</td>
<td align="left" valign="top">Writer &amp;1 not active nor on job queue.</td>
</tr>
<tr>
<td align="left" valign="top">CPF33C8 E</td>
<td align="left" valign="top">No writer information returned for printer &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9800 E</td>
<td align="left" valign="top">All CPF98xx messages could be signaled. xx is from 01 to
FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
</table>
<hr>
API introduced: V3R6
<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=
"print1.htm">Print APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink