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

2430 lines
67 KiB
HTML
Raw Permalink Blame History

<!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 Output Queue Information (QSPROUTQ) 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 Output Queue Information (QSPROUTQ) 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">Qualified output queue name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(20)</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 Output Queue Information (QSPROUTQ) API returns information
about the parameters used to create the queue, the current status of the queue,
and the number of entries on the queue.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Output Queue Library Authority</em></dt>
<dd>The caller needs *EXECUTE authority to the output queue library.</dd>
<dt><em>Output Queue Authority</em></dt>
<dd>The caller needs one of the following:
<ul>
<li>*READ authority to the output queue.</li>
<li>Job control special authority (*JOBCTL) if the output queue is operator
controlled (*OPRCTL(*YES)).</li>
<li>Spool control special authority (*SPLCTL).</li>
</ul>
</dd>
<dt><em>Output Queue Lock</em></dt>
<dd>This API needs an *EXCLRD lock on the output queue.</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The variable that receives the information requested.</p>
<br>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable provided by the receiver variable
parameter. The amount of data returned is truncated if the receiver variable is
too small. A length of less than 8 is not valid. If the length specified is
greater than the actual length, the results may be unpredictable.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the queue information being returned.</p>
<p>You must specify one of the following:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td valign="top"><em><a href="#HDROUTQ100">OUTQ0100</a></em></td>
<td valign="top">Contains the basic information about the output queue and only
one of the writers that is started to the queue.</td>
</tr>
<tr>
<td valign="top"><em><a href="#HDROUTQ200">OUTQ0200</a></em></td>
<td valign="top">Contains the basic information about the output queue and all
of the writers that are started to the queue.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Qualified output queue name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The name of the output queue for which information is returned. The first 10
characters contain the queue name and the second 10 characters contain the name
of the library in which the queue resides.</p>
<p>The following special values are supported for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*LIBL</em></td>
<td valign="top">The library list used to locate the queue.</td>
</tr>
<tr>
<td valign="top"><em>*CURLIB</em></td>
<td valign="top">The current library for the job is used to locate the
queue.</td>
</tr>
</table>
<br>
</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><a name="HDROUTQ100">OUTQ0100 Format</a></h3>
<p>The following table shows the information returned for the OUTQ0100 format.
For more details about the fields in the following table, see <a href=
"#HDRXFIELDD">Field Descriptions</a>.</p>
<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(10)</td>
<td align="left" valign="top">Output queue name</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</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">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Order of files on queue</td>
</tr>
<tr>
<td align="center" valign="top">38</td>
<td align="center" valign="top">26</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Display any file</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Job separators</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Operator controlled</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="center" valign="top">3E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Data queue name</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Data queue library name</td>
</tr>
<tr>
<td align="center" valign="top">82</td>
<td align="center" valign="top">52</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Authority to check</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of files</td>
</tr>
<tr>
<td align="center" valign="top">96</td>
<td align="center" valign="top">60</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Output queue status</td>
</tr>
<tr>
<td align="center" valign="top">106</td>
<td align="center" valign="top">6A</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">116</td>
<td align="center" valign="top">74</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">126</td>
<td align="center" valign="top">7E</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">132</td>
<td align="center" valign="top">84</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Writer job status</td>
</tr>
<tr>
<td align="center" valign="top">142</td>
<td align="center" valign="top">8E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Printer device name</td>
</tr>
<tr>
<td align="center" valign="top">152</td>
<td align="center" valign="top">98</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">202</td>
<td align="center" valign="top">CA</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">204</td>
<td align="center" valign="top">CC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of spooled file pages specified</td>
</tr>
<tr>
<td align="center" valign="top">208</td>
<td align="center" valign="top">D0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of writers started to queue</td>
</tr>
<tr>
<td align="center" valign="top">212</td>
<td align="center" valign="top">D4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Writers to autostart</td>
</tr>
<tr>
<td align="center" valign="top">216</td>
<td align="center" valign="top">D8</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Remote system name type</td>
</tr>
<tr>
<td align="center" valign="top">217</td>
<td align="center" valign="top">D9</td>
<td align="left" valign="top">CHAR(255)</td>
<td align="left" valign="top">Remote system name</td>
</tr>
<tr>
<td align="center" valign="top">472</td>
<td align="center" valign="top">1D8</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">Remote printer queue</td>
</tr>
<tr>
<td align="center" valign="top">600</td>
<td align="center" valign="top">258</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">610</td>
<td align="center" valign="top">262</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">620</td>
<td align="center" valign="top">26C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Connection type</td>
</tr>
<tr>
<td align="center" valign="top">624</td>
<td align="center" valign="top">270</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Destination type</td>
</tr>
<tr>
<td align="center" valign="top">628</td>
<td align="center" valign="top">274</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">VM/MVS class</td>
</tr>
<tr>
<td align="center" valign="top">629</td>
<td align="center" valign="top">275</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Forms control buffer</td>
</tr>
<tr>
<td align="center" valign="top">637</td>
<td align="center" valign="top">27D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Host print transform</td>
</tr>
<tr>
<td align="center" valign="top">638</td>
<td align="center" valign="top">27E</td>
<td align="left" valign="top">CHAR(17)</td>
<td align="left" valign="top">Manufacturer type and model</td>
</tr>
<tr>
<td align="center" valign="top">655</td>
<td align="center" valign="top">28F</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Workstation customizing object name</td>
</tr>
<tr>
<td align="center" valign="top">665</td>
<td align="center" valign="top">299</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Workstation customizing object library name</td>
</tr>
<tr>
<td align="center" valign="top">675</td>
<td align="center" valign="top">2A3</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Spooled file auxiliary storage pool
attribute</td>
</tr>
<tr>
<td align="center" valign="top">676</td>
<td align="center" valign="top">2A4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to maximum spooled file page entries</td>
</tr>
<tr>
<td align="center" valign="top">680</td>
<td align="center" valign="top">2A8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of page entries returned</td>
</tr>
<tr>
<td align="center" valign="top">684</td>
<td align="center" valign="top">2AC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of each size entry</td>
</tr>
<tr>
<td align="center" valign="top">688</td>
<td align="center" valign="top">2B0</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">Destination options</td>
</tr>
<tr>
<td align="center" valign="top">816</td>
<td align="center" valign="top">330</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Writer type started to queue</td>
</tr>
<tr>
<td align="center" valign="top">817</td>
<td align="center" valign="top">331</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Print separator page</td>
</tr>
<tr>
<td align="center" valign="top">818</td>
<td align="center" valign="top">332</td>
<td align="left" valign="top">CHAR(255)</td>
<td align="left" valign="top">Long remote printer queue</td>
</tr>
<tr>
<td align="center" valign="top">1073</td>
<td align="center" valign="top">431</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Image configuration</td>
</tr>
<tr>
<td align="center" valign="top">1083</td>
<td align="center" valign="top">43B</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Image configuration library</td>
</tr>
<tr>
<td align="center" valign="top">1093</td>
<td align="center" valign="top">445</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">1094</td>
<td align="center" valign="top">446</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">1096</td>
<td align="center" valign="top">448</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Spooled file auxiliary storage pool ID</td>
</tr>
<tr>
<td align="center" valign="top">1100</td>
<td align="center" valign="top">44C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Spooled file auxiliary storage pool device name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Spooled file maximum page entries</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDROUTQ200">OUTQ0200 Format</a></h3>
<p>The following table shows the information returned for the OUTQ0200 format.
For more details about the fields in the following table, see <a href=
"#HDRXFIELDD">Field Descriptions</a>.</p>
<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(10)</td>
<td align="left" valign="top">Output queue name</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</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">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Order of files on queue</td>
</tr>
<tr>
<td align="center" valign="top">38</td>
<td align="center" valign="top">26</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Display any file</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Job separators</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Operator controlled</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="center" valign="top">3E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Data queue name</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Data queue library name</td>
</tr>
<tr>
<td align="center" valign="top">82</td>
<td align="center" valign="top">52</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Authority to check</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of files</td>
</tr>
<tr>
<td align="center" valign="top">96</td>
<td align="center" valign="top">60</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Output queue status</td>
</tr>
<tr>
<td align="center" valign="top">106</td>
<td align="center" valign="top">6A</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">156</td>
<td align="center" valign="top">9C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of spooled file pages specified</td>
</tr>
<tr>
<td align="center" valign="top">160</td>
<td align="center" valign="top">A0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of writers started to queue</td>
</tr>
<tr>
<td align="center" valign="top">164</td>
<td align="center" valign="top">A4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Writers to autostart</td>
</tr>
<tr>
<td align="center" valign="top">168</td>
<td align="center" valign="top">A8</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Remote system name type</td>
</tr>
<tr>
<td align="center" valign="top">169</td>
<td align="center" valign="top">A9</td>
<td align="left" valign="top">CHAR(255)</td>
<td align="left" valign="top">Remote system name</td>
</tr>
<tr>
<td align="center" valign="top">424</td>
<td align="center" valign="top">1A8</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">Remote printer queue</td>
</tr>
<tr>
<td align="center" valign="top">552</td>
<td align="center" valign="top">228</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">562</td>
<td align="center" valign="top">232</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">572</td>
<td align="center" valign="top">23C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Connection type</td>
</tr>
<tr>
<td align="center" valign="top">576</td>
<td align="center" valign="top">240</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Destination type</td>
</tr>
<tr>
<td align="center" valign="top">580</td>
<td align="center" valign="top">244</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">VM/MVS class</td>
</tr>
<tr>
<td align="center" valign="top">581</td>
<td align="center" valign="top">245</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Forms control buffer</td>
</tr>
<tr>
<td align="center" valign="top">589</td>
<td align="center" valign="top">24D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Host print transform</td>
</tr>
<tr>
<td align="center" valign="top">590</td>
<td align="center" valign="top">24E</td>
<td align="left" valign="top">CHAR(17)</td>
<td align="left" valign="top">Manufacturer type and model</td>
</tr>
<tr>
<td align="center" valign="top">607</td>
<td align="center" valign="top">25F</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Workstation customizing object name</td>
</tr>
<tr>
<td align="center" valign="top">617</td>
<td align="center" valign="top">269</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Workstation customizing object library name</td>
</tr>
<tr>
<td align="center" valign="top">627</td>
<td align="center" valign="top">273</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Spooled file auxiliary storage pool
attribute</td>
</tr>
<tr>
<td align="center" valign="top">628</td>
<td align="center" valign="top">274</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to maximum spooled file page entries</td>
</tr>
<tr>
<td align="center" valign="top">632</td>
<td align="center" valign="top">278</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of page entries returned</td>
</tr>
<tr>
<td align="center" valign="top">636</td>
<td align="center" valign="top">27C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of each size entry</td>
</tr>
<tr>
<td align="center" valign="top">640</td>
<td align="center" valign="top">280</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to writer entries</td>
</tr>
<tr>
<td align="center" valign="top">644</td>
<td align="center" valign="top">284</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of writer entries returned</td>
</tr>
<tr>
<td align="center" valign="top">648</td>
<td align="center" valign="top">288</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of each writer entry</td>
</tr>
<tr>
<td align="center" valign="top">652</td>
<td align="center" valign="top">28C</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">Destination options</td>
</tr>
<tr>
<td align="center" valign="top">780</td>
<td align="center" valign="top">30C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Writer type started to queue</td>
</tr>
<tr>
<td align="center" valign="top">781</td>
<td align="center" valign="top">30D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Print separator page</td>
</tr>
<tr>
<td align="center" valign="top">782</td>
<td align="center" valign="top">30E</td>
<td align="left" valign="top">CHAR(255)</td>
<td align="left" valign="top">Long remote printer queue</td>
</tr>
<tr>
<td align="center" valign="top">1037</td>
<td align="center" valign="top">40D</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">1040</td>
<td align="center" valign="top">410</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to user-defined options</td>
</tr>
<tr>
<td align="center" valign="top">1044</td>
<td align="center" valign="top">414</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of user-defined options returned</td>
</tr>
<tr>
<td align="center" valign="top">1048</td>
<td align="center" valign="top">418</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of each user-defined option entry</td>
</tr>
<tr>
<td align="center" valign="top">1052</td>
<td align="center" valign="top">41C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to user-defined data</td>
</tr>
<tr>
<td align="center" valign="top">1056</td>
<td align="center" valign="top">420</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes of user-defined data returned</td>
</tr>
<tr>
<td align="center" valign="top">1060</td>
<td align="center" valign="top">424</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes of user-defined data available</td>
</tr>
<tr>
<td align="center" valign="top">1064</td>
<td align="center" valign="top">428</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User-defined object name</td>
</tr>
<tr>
<td align="center" valign="top">1074</td>
<td align="center" valign="top">432</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User-defined object library name</td>
</tr>
<tr>
<td align="center" valign="top">1084</td>
<td align="center" valign="top">43C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User object type</td>
</tr>
<tr>
<td align="center" valign="top">1094</td>
<td align="center" valign="top">446</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User driver program name</td>
</tr>
<tr>
<td align="center" valign="top">1104</td>
<td align="center" valign="top">450</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User driver program library name</td>
</tr>
<tr>
<td align="center" valign="top">1114</td>
<td align="center" valign="top">45A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Data transform program name</td>
</tr>
<tr>
<td align="center" valign="top">1124</td>
<td align="center" valign="top">464</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Data transform program library name</td>
</tr>
<tr>
<td align="center" valign="top">1134</td>
<td align="center" valign="top">46E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Image configuration</td>
</tr>
<tr>
<td align="center" valign="top">1144</td>
<td align="center" valign="top">478</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Image configuration library</td>
</tr>
<tr>
<td align="center" valign="top">1154</td>
<td align="center" valign="top">482</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">1155</td>
<td align="center" valign="top">483</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">1156</td>
<td align="center" valign="top">484</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Spooled file auxiliary storage pool ID</td>
</tr>
<tr>
<td align="center" valign="top">1160</td>
<td align="center" valign="top">488</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Spooled file auxiliary storage pool device name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Spooled file maximum page entries</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Writer entries</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">User-defined option entries</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">User-defined data</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDROQ200MP">Format of Spooled File Maximum Page Entry</a></h3>
<p>Each spooled file size entry has the following structure. For more details
about the fields in the following table, see <a href="#HDRXFIELDD">Field
Descriptions</a>.</p>
<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%">Number of pages</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Starting time</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Ending time</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDROQ200WE">Format of Writer Entry</a></h3>
<p>Each writer entry from format OUTQ0200 has the following structure. For more
details about the fields in the following table, see <a href=
"#HDRXFIELDD">Field Descriptions</a>.</p>
<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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Writer job name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</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">20</td>
<td align="center" valign="top">14</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">26</td>
<td align="center" valign="top">1A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Writer job status</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Printer device name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDROQ200UD">Format of User-Defined Option Entry</a></h3>
<p>Each user-defined option entry has the following structure. For more details
about the fields in the following table, see <a href="#HDRXFIELDD">Field
Descriptions</a>.</p>
<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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">User-defined option</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRXFIELDD">Field Descriptions</a></h3>
<p><strong>Authority to check.</strong> Indicates what type of authorities to
the output queue allow the user to control all the files on the queue.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*OWNER</em></td>
<td align="left" valign="top">Only the owner of the output queue can control
all the output files on the queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DTAAUT</em></td>
<td align="left" valign="top">Any user with *READ, *ADD, or *DELETE authority
to the output queue can control all output files on the queue.</td>
</tr>
</table>
<br>
<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>Bytes of user-defined data available.</strong> The number of bytes
of user-defined data available to be returned. All available data is returned
if enough space is provided.</p>
<p><strong>Bytes of user-defined data returned.</strong> The number of bytes of
user-defined data returned.</p>
<p><strong>Connection type.</strong> The type of network connection to the
remote system.</p>
<p>Values include:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The destination type is not specified when the
remote system is *NONE.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The SNADS network is used as the connectivity to
the remote system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The TCP/IP network is used as the connectivity to
the remote system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">
The IPX network is used as the connectivity to the remote system. This value is
no longer supported by ISeries 400. </td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Reserved.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">A user-defined connectivity is used as the
connectivity to the remote system.</td>
</tr>
</table>
<br>
<p><strong>Data queue library name.</strong> The name of the library that
contains the data queue.</p>
<p><strong>Data queue name.</strong> Name of the data queue associated with
this output queue. Whenever a spooled file goes into ready status on the output
queue, an entry is placed on the data queue.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No data queue is associated with this output
queue.</td>
</tr>
</table>
<br>
<p><strong>Data transform program library name.</strong> The name of the
library that contains the data transform program.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list used to locate the data
transform program.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The current library for the job is used to locate
the data transform program.</td>
</tr>
</table>
<br>
<p><strong>Data transform program name.</strong> The name of the user-specified
data transform program that is used by the driver program.</p>
<p>The following values are supported:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No data transform program is specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Data transform program name</em></td>
<td align="left" valign="top">The name of the data transform program.</td>
</tr>
</table>
<br>
<p><strong>Destination options.</strong> Destination-dependent options that are
specific to a particular implementation of an LPR Print Server.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No destination-dependent options have been
specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NOWAIT</em></td>
<td align="left" valign="top">The remote writer will not wait for confirmation
that the destination system has finished processing the spooled file. This
value is used only when the connection type is *IP and the destination type is
*NDS or *SNA. </td>
</tr>
<tr>
<td align="left" valign="top"><em>*USRDFNTXT</em></td>
<td align="left" valign="top">Use the value for the user-defined text of the
user profile when the spooled file was created.</td>
</tr>
<tr>
<td align="left" valign="top"><em>destination options</em></td>
<td align="left" valign="top">The destination-dependent options specified on
the output queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">This field is blank when the connection type is 0
(*NONE) or when the connection type is 1 (*SNA).</td>
</tr>
</table>
<br>
<p><strong>Destination type.</strong> The type of destination system that
spooled files on this output queue are being sent to.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top">0</td>
<td align="left" valign="top">The destination type is not specified when the
remote system is *NONE.</td>
</tr>
<tr>
<td align="left" valign="top">1</td>
<td align="left" valign="top">The destination system is an iSeries server.</td>
</tr>
<tr>
<td align="left" valign="top">2</td>
<td align="left" valign="top">The destination system is an iSeries server
running i5/OS (OS/400) version 2.</td>
</tr>
<tr>
<td align="left" valign="top">3</td>
<td align="left" valign="top">This destination system is a System/390
system.</td>
</tr>
<tr>
<td align="left" valign="top">4</td>
<td align="left" valign="top">The destination system is a PC using Print
Services Facility/2.</td>
</tr>
<tr>
<td align="left" valign="top">5</td>
<td align="left" valign="top">Reserved.</td>
</tr>
<tr>
<td align="left" valign="top">
6</td>
<td align="left" valign="top">The destination system is accessed with
NETWARE3**. This value is no longer supported by ISeries 400. </td>
</tr>
<tr>
<td align="left" valign="top">7</td>
<td align="left" valign="top">The destination system is accessed with
NETWARE4**.</td>
</tr>
<tr>
<td align="left" valign="top">-1</td>
<td align="left" valign="top">The destination system is not a system matching
any of the other special values.</td>
</tr>
</table>
<p><strong>Display any file.</strong> Whether users who have authority to read
this output queue can display the output data of any output file on this queue,
or only the data in their own files.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">Any user having authority to read the queue can
display, copy, or send the data of any file on the queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">Users authorized to use the queue can display,
copy, or send the output data of their own files only, unless they have some
special authority.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*OWNER</em></td>
<td align="left" valign="top">Only the owner of a file or a user with *SPLCTL
authority can display, copy, send, or move their own spooled files to another
output queue.</td>
</tr>
</table>
<br>
<p><strong>Ending time.</strong> The ending time portion of the maximum spooled
file page entry. It specifies the time of day that the maximum spooled file
page is to end. The ending time is given in 24-hour format with a time
separator (hh:mm:ss), where hh equals hours, mm equals minutes, and ss equals
seconds.</p>
<p><strong>Forms control buffer.</strong> The forms control buffer for files
sent to a VM/MVS host system.</p>
<p><strong>Note:</strong> This information is valid only when the connection
type is 1 and the destination type is 3.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No FCB is used when sending spooled files.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*USRDTA</em></td>
<td align="left" valign="top">The first 8 characters of the user data (USRDATA)
spooled file attribute determine the name of the FCB. If the user data is
blank, no FCB is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PRTF</em></td>
<td align="left" valign="top">The first 8 characters of the printer file used
to spool the file determine the name of the FCB.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>FCB-name</em></td>
<td align="left" valign="top">The name of the FCB to be used.</td>
</tr>
</table>
<br>
<p><strong>Host print transform.</strong> Whether to use the host print
transform function to transform a spooled file. This field was previously
called transform SCS to ASCII.</p>
<p>Values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">Used when the connection type is 1 (*SNA) and the
user driver program is *NONE.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not transform data streams using host print
transform.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Transform data streams using host print
transform.</td>
</tr>
</table>
<br>
<p><strong>Image configuration.</strong> The transform services for a variety
of image and print data-stream formats. (See the IMGCFG keyword in the <a href=
"../books/c4154010.pdf" target="_blank">Communications Configuration</a>
<img src="wbpdf.gif" alt="Link to PDF"> book.)</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No image configuration is used when transforming
the spooled file before sending.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Image-configuration-name</em></td>
<td align="left" valign="top">The name of the image configuration.</td>
</tr>
</table>
<br>
<p><strong>Image configuration library.</strong> The library in which the image
configuration is located. This field is always set to blanks.</p>
<p><strong>Job separators.</strong> The number of job separators to be placed
at the beginning of the output for each job having spooled file entries on this
output queue.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top" nowrap><em>0-9</em></td>
<td align="left" valign="top">The desired number of job separators.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>-2</em></td>
<td align="left" valign="top">No job separators are used; instead a message is
sent to the writer's message queue at the end of each job indicating that the
output can be removed.</td>
</tr>
</table>
<br>
<p><strong>Length of each size entry.</strong> The length, in bytes, of each
spooled file size entry.</p>
<p><strong>Length of each user-defined option entry.</strong> The length, in
bytes, of each user-defined option entry.</p>
<p><strong>Length of each writer entry.</strong> The length, in bytes, of each
writer entry.</p>
<p><strong>Length of user-defined data.</strong> The length, in bytes, of the
user-defined data.</p>
<p><strong>Long remote printer queue.</strong> The name of the remote
printer.</p>
<p>Possible values include:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*USER</em></td>
<td align="left" valign="top">The user profile that creates the spooled file
will determine the user ID on the remote system that it is sent to.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSTEM</em></td>
<td align="left" valign="top">The default system printer on the remote system
will determine the printer queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>printer queue name</em></td>
<td align="left" valign="top">The name of the printer queue to which the remote
writer will send files on the remote system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">The name of the printer queue will be blank for
output queues that are not remote output queues.</td>
</tr>
</table>
<br>
<p><strong>Manufacturer type and model.</strong> The manufacturer, type, and
model for a printer using the host print transform function.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*IBM42011</em></td>
<td align="left" valign="top">The IBM 4201-1 Proprinter printer is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*WSCST</em></td>
<td align="left" valign="top">The workstation customizing object is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">Used when the connection type is 1(*SNA), or when
the connection type is 2(*IP) and the host print transform is 0.</td>
</tr>
</table>
<br>
<p><strong>Message queue library name.</strong> The library of the message
queue.</p>
<p><strong>Message queue name.</strong> The name of the message queue to which
messages, created by the remote writer started to this output queue, are
sent.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>message queue name</em></td>
<td align="left" valign="top">The message queue to which messages are to be
sent.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">The message queue is blank when the output queue
is not a remote output queue.</td>
</tr>
</table>
<br>
<p><strong>Network directory publishing status.</strong> Whether the output
queue is published in the network directory.</p>
<p>Possible values include:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Output queue is not published</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Output queue is published</td>
</tr>
</table>
<br>
<p><strong>Number of files.</strong> The number of spooled files that exist on
the output queue.</p>
<p><strong>Number of pages.</strong> Only files with this number of pages or
less will print between the starting and ending times.</p>
<p><strong>Number of spooled file pages specified.</strong> In a spooled file,
the maximum number of pages allowed on the output queue as determined by the
output queue definition from the Create Output Queue (CRTOUTQ) command.</p>
<p><strong>Number of page entries returned.</strong> The number of maximum
spooled file page entries returned in this format. Only complete entries will
be returned.</p>
<p><strong>Number of user-defined options returned.</strong> The number of
user-defined option entries returned in this format. Only complete entries are
returned.</p>
<p><strong>Number of writer entries returned.</strong> The number of writer
entries returned in this format. Depending on the bytes available, this could
be less than the number of writers started. Only complete entries will be
returned.</p>
<p><strong>Number of writers started to queue.</strong> The number of printer
writers that have been started to this output queue.</p>
<p><strong>Offset to maximum spooled file page entries.</strong> The offset to
the maximum spooled file page entry. A maximum spooled file page entry
specifies the requirements a spooled file must meet to be printed from the
output queue. The maximum number of pages, the starting time, and the ending
time define these requirements.</p>
<p><strong>Offset to user-defined data.</strong> The offset to information
about the user-defined data.</p>
<p><strong>Offset to user-defined options.</strong> The offset to information
about each user-defined option entry. Each entry contains the user-defined
option.</p>
<p><strong>Offset to writer entries.</strong> The offset to information about
each writer that is started to the output queue. Each entry contains the writer
job name, writer job user name, writer job number, writer job status, and
printer device name.</p>
<p><strong>Operator controlled.</strong> Whether users with job control
authority are allowed to manage or control the files on this queue. Users have
job control authority if SPCAUT(*JOBCTL) is specified in their user
profile.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">Users with job control authority can control the
queue and make changes to the files on the queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">This queue and its entries cannot be controlled
or changed by users with job control authority unless they also have some other
special authority.</td>
</tr>
</table>
<br>
<p><strong>Order of files on queue.</strong> The order of the spooled files on
the output queue.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*FIFO</em></td>
<td align="left" valign="top">The queue is first-in first-out for each file.
That is, on the queue, new spooled files are placed after all other spooled
files that have the same priority.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*JOBNBR</em></td>
<td align="left" valign="top">The queue entries for the spooled files are
sorted in priority sequence using the job number (the date and time that the
job entered the system) of the job that created the spooled file.</td>
</tr>
</table>
<br>
<p><strong>Output queue library name.</strong> The name of the library that
contains the output queue.</p>
<p><strong>Output queue name.</strong> The name of the output queue.</p>
<p><strong>Output queue status.</strong> The status of the output queue.</p>
<p>The status may be one of the following values:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>RELEASED</em></td>
<td align="left" valign="top">The queue is released.</td>
</tr>
<tr>
<td align="left" valign="top"><em>HELD</em></td>
<td align="left" valign="top">The queue is held.</td>
</tr>
</table>
<br>
<p><strong>Printer device name.</strong> The name of the printer device.</p>
<p>For format OUTQ0100 the following applies:</p>
<ul>
<li>This field is blank when a writer job is not started to this queue.<br>
</li>
<li>This field contains the first printer device when the number of writers
started to this output queue is greater than 1.</li>
</ul>
<p><strong>Print separator page.</strong> Whether to print a separator page
when printing the spooled file on the remote system.</p>
<p>Possible values include:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">The connection type is neither 2 (*IP) nor 5
(*USRDFN).</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not print a separator page.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Print a separator page.</td>
</tr>
</table>
<br>
<p><strong>Remote printer queue.</strong> The name of the remote printer.</p>
<p>Possible values include:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*USER</em></td>
<td align="left" valign="top">The user profile that creates the spooled file
will determine the user ID on the remote system that it is sent to.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSTEM</em></td>
<td align="left" valign="top">The default system printer on the remote system
will determine the printer queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>printer queue name</em></td>
<td align="left" valign="top">The name of the printer queue to which the remote
writer will send files on the remote system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">The name of the printer queue will be blank for
output queues that are not remote output queues. This field will also be blank
if the name of the printer queue will not fit in 128 bytes.</td>
</tr>
</table>
<br>
<p><strong>Remote system name.</strong> The name of the remote system. The
format of the name is dependent on the name type. When the remote system name
type is 0 (*NONE) or 1 (*PASTHR), the remote system name is blank. When the
name type is 2 (system name), the remote system name is up to 255 characters.
When the name type is 3 (Internet address), the remote system name is a
15-character address in the form nnn.nnn.nnn.nnn, and the remaining characters
are blank.</p>
<p><strong>Remote system name type.</strong> The type of remote system
name.</p>
<p>Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">There is no remote system name specified</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The output is routed to the system from where the
pass-through was issued (*PASTHR).</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The name of the remote system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Internet address</td>
</tr>
</table>
<br>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Spooled file auxiliary storage pool attribute.</strong> The
auxiliary storage pool (ASP) where the spooled files are to reside.</p>
<p>The 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">*SYSTEM: The spooled files reside in the system
auxiliary storage pool.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">*OUTQASP: The spooled files reside in the
auxiliary storage pool in which the output queue resides.</td>
</tr>
</table>
<p><strong>Spooled file auxiliary storage pool device name.</strong> The name of the
auxiliary storage pool (ASP) device where the spooled files reside.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SYSBAS</em></td>
<td align="left" valign="top">The spooled files reside in the system ASP
(ASP 1) or one of the defined basic user ASPs (ASPs 2-32).</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>auxiliary storage pool device name</em></td>
<td align="left" valign="top">The name of the auxiliary storage pool device where the spooled files reside.</td>
</tr>
</table>
<br>
<p><strong>Spooled file auxiliary storage pool ID.</strong> The number of the
auxiliary storage pool (ASP) where the spooled files reside.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">*SYSTEM: The spooled files reside in the system
auxiliary storage pool.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>2-255</em></td>
<td align="left" valign="top">The number of the auxiliary storage pool
where the spooled files reside.</td>
</tr>
</table>
<br>
<p><strong>Spooled file maximum page entries.</strong> One maximum page entry
is returned for each spooled file maximum page entry defined in the output
queue. The number of entries may vary from one output queue to another. See <a
href="#HDROQ200MP">Format of Spooled File Maximum Page Entry</a> for the format
of each entry.</p>
<p><strong>Starting time.</strong> The starting time portion of the maximum
spooled file page array. The starting time is given in 24-hour format with a
time separator (hh:mm:ss), where hh equals hours, mm equals minutes, and ss
equals seconds.</p>
<p><strong>Text description.</strong> Text that briefly describes the output
queue.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*BLANK</em></td>
<td align="left" valign="top">There is no text description of the job
queue.</td>
</tr>
</table>
<br>
<p><strong>User-defined data.</strong> Data defined by the user to be used by
user applications or user-specified programs that process spooled files.</p>
<p><strong>User-defined object library name.</strong> The name of the library
that contains the user-defined object.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list used to locate the user-defined
object.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The current library for the job is used to locate
the user-defined object.</td>
</tr>
</table>
<br>
<p><strong>User-defined object name.</strong> The name of the user-defined
object that is used by user applications or user-specified programs that
process spooled files.</p>
<p>The following values are supported:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No user-defined object is specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>User-defined object name</em></td>
<td align="left" valign="top">The name of the object defined by the user.</td>
</tr>
</table>
<br>
<p><strong>User-defined option.</strong> The option defined by the user to be
used by user applications or user-specified programs that process spooled
files. When the number of user-defined options returned is 0, there are no
user-defined options.</p>
<p><strong>User-defined option entries.</strong> One entry is returned for each
user-defined option. The number of entries may vary from one output queue to
another. See <a href="#HDROQ200UD">Format of User-Defined Option Entry</a> for
the format of each entry.</p>
<p><strong>User driver program library name.</strong> The name of the library
that contains the user driver program.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list used to locate the user driver
program.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The current library for the job is used to locate
the user driver program.</td>
</tr>
</table>
<br>
<p><strong>User driver program name.</strong> The name of the user-specified
driver program that is used to process the spooled files on the output
queue.</p>
<p>The following values are supported:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No user driver program is specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>User driver program name</em></td>
<td align="left" valign="top">The name of the user-specified driver
program.</td>
</tr>
</table>
<br>
<p><strong>User object type.</strong> The type of the user-defined object.</p>
<p>The following values are supported:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>User object type</em></td>
<td align="left" valign="top">The user object type can be data area (*DTAARA),
data queue (*DTAQ), file (*FILE), PSF configuration object (*PSFCFG), user
index (*USRIDX), user queue (*USRQ), and user space (*USRSPC).</td>
</tr>
</table>
<br>
<p><strong>Note:</strong> A blank value is returned when the name of the
user-defined object is *NONE.</p>
<p><strong>VM/MVS class.</strong> The VM/MVS SYSOUT class for distributions
sent to a VM host system or to a MVS host system.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>A-Z, 0-9</em></td>
<td align="left" valign="top">The distribution class.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">Used when the connection type is 1(*SNA).</td>
</tr>
</table>
<br>
<p><strong>Workstation customizing object library name.</strong> The library
name for the workstation customizing object. This field is blank when the
connection type is 1(*SNA) and the user driver program is *NONE.</p>
<p><strong>Workstation customizing object name.</strong> The name of an object
that consists of a table of attributes used to customize a given ASCII
device.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no workstation customizing object.</td>
</tr>
<tr>
<td align="left" valign="top"><em>name</em></td>
<td align="left" valign="top">The name of the workstation customizing object,
which has been created by the Create Work Station Customizing Object (CRTWSCST)
command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">Used when the connection type is 1(*SNA) and the
user driver program is *NONE.</td>
</tr>
</table>
<br>
<p><strong>Writer entries.</strong> One writer entry is returned for each
writer that is started to the output queue. The number of writer entries may
vary from one output queue to another. See <a href="#HDROQ200WE">Format of
Writer Entry</a> for the format of each entry.</p>
<p><strong>Writer job name.</strong> The name of the writer job.</p>
<p>The following applies:</p>
<ul>
<li>This field is blank when a writer job is not started to this queue.</li>
<li>For OUTQ0100, this field contains the first writer job name when the number
of writers started to this output queue is greater than 1.</li>
</ul>
<p><strong>Writer job number.</strong> The job number associated with the
writer job.</p>
<p>The following applies:</p>
<ul>
<li>This field is blank when a writer job is not started to this queue.</li>
<li>For OUTQ0100, this field contains the first writer job number when the
number of writers started to this output queue is greater than 1.</li>
</ul>
<p><strong>Writer job status.</strong> The status of the writer job.</p>
<p>The following applies:</p>
<ul>
<li>This field is blank when a writer job is not started to this queue.</li>
<li>For OUTQ0100, this field contains the first writer job status when the
number of writers started to this output queue is greater than 1.</li>
</ul>
<p>The status may be one of the following values.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>STR</em></td>
<td align="left" valign="top">The writer job is started to the output
queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>END</em></td>
<td align="left" valign="top">The writer job is ended.</td>
</tr>
<tr>
<td align="left" valign="top"><em>JOBQ</em></td>
<td align="left" valign="top">The writer job is on the job queue</td>
</tr>
<tr>
<td align="left" valign="top"><em>HLD</em></td>
<td align="left" valign="top">The writer job is held.</td>
</tr>
<tr>
<td align="left" valign="top"><em>MSGW</em></td>
<td align="left" valign="top">The writer job is waiting for a message.</td>
</tr>
</table>
<br>
<p><strong>Writer job user name.</strong> The name of the user who started the
writer job.</p>
<p>The following applies:</p>
<ul>
<li>This field is blank when a writer job is not started to this queue.</li>
<li>For OUTQ0100, this field contains the first writer job user name when the
number of writers started to this output queue is greater than 1.</li>
</ul>
<p><strong>Writers to autostart.</strong> The number of remote printer writers
to autostart to this output queue at system IPL.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No writers are automatically started to this
output queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>number of writers</em></td>
<td align="left" valign="top">The number of writers automatically started to
this output queue.</td>
</tr>
</table>
<br>
<p><strong>Writer type started to queue.</strong> The type of writer started to
this output queue.</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 writer</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Diskette writer</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Remote writer</td>
</tr>
</table>
<br>
<br>
<h3>Error Messages</h3>
<table width="100%">
<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">CPF2207 E</td>
<td width="85%" valign="top">Not authorized to use object &amp;1 in library
&amp;3 type *&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</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">CPF3C19 E</td>
<td align="left" valign="top">Error occurred with receiver variable
specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C24 E</td>
<td align="left" valign="top">Length of the receiver variable is not
valid.</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">CPF3330 E</td>
<td align="left" valign="top">Necessary resource not available.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3357 E</td>
<td align="left" valign="top">Output queue &amp;1 in library &amp;2 not
found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8122 E</td>
<td align="left" valign="top">&amp;8 damage on library &amp;4.</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>
<br>
<hr>
API introduced: V2R2
<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 View Git Blame Copy Permalink