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/qsprjobq.htm

1027 lines
29 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 Job Queue Information (QSPRJOBQ) 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. -->
<!-- WM 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 cleanup completed on 16 July 2001 -->
<!-- File cleanup completed Feb 2002 by v2cdijab -->
<!-- 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Retrieve Job Queue Information (QSPRJOBQ) API</h2>
<div class="box" style="width: 80%;">
<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 job 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 Job Queue Information (QSPRJOBQ) API retrieves information
associated with a specified job queue.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Job Queue Library Authority</em></dt>
<dd>The caller needs *EXECUTE authority to the job queue library.<br>
<br>
</dd>
<dt><em>Job Queue Authority</em></dt>
<dd>The caller needs one of the following:<br>
<br>
<ul>
<li>*READ authority to the job queue.</li>
<li>Job control special authority (*JOBCTL) if the job queue is operator
controlled (OPRCTL(*YES)).</li>
<li>Spool control special authority (*SPLCTL).</li>
</ul>
<br>
</dd>
<dt><em>Job Queue Lock</em></dt>
<dd>This API gets an *EXCLRD lock on the job queue.<br>
<br>
</dd>
<dt><em>Subsystem Description Lock</em></dt>
<dd>This API gets an *EXCLRD lock on the subsystem description.</dd>
</dl>
<p>This API does not check the caller's authority to the subsystem description
or subsystem description library when retrieving the subsystem description
information.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The variable that is to receive the information requested.</p>
</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 it is too small. A
length of less than 8 is not valid.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the queue information being returned. The valid
format names are:<br>
<br>
</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>JOBQ0100</em></td>
<td align="left" valign="top">Basic job queue information. See <a href=
"#HDRJOBQ100">JOBQ0100 Format</a> to view the information returned for this
format.</td>
</tr>
<tr>
<td align="left" valign="top"><em>JOBQ0200</em></td>
<td align="left" valign="top">Detailed job queue information. See <a href=
"#HDRJOBQ200">JOBQ0200 Format</a> to view the information returned for this
format.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Qualified job queue name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The name of the job 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 align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list used to locate the job
queue.</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 job 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="HDRJOBQ100">JOBQ0100 Format</a></h3>
<p>The following table shows the information returned for the JOBQ0100 format.
For more details about the fields in the following table, see <a href=
"#HDRFD1XX">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">Job 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">Job 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">Operator controlled</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">Authority to check</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">Number of jobs</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">Job queue status</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">Subsystem name</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">122</td>
<td align="center" valign="top">7A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Subsystem library name</td>
</tr>
<tr>
<td align="center" valign="top">132</td>
<td align="center" valign="top">84</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Sequence number</td>
</tr>
<tr>
<td align="center" valign="top">136</td>
<td align="center" valign="top">88</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum active</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">Current active</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRJOBQ200">JOBQ0200 Format</a></h3>
<p>The following table shows the information returned for the JOBQ0200 format.
For more details about the fields in the following table see, <a href=
"#HDRFD1XX">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">Job 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">Job 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">Operator controlled</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">Authority to check</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">Number of jobs</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">Job queue status</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">Subsystem 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">Subsystem 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(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">132</td>
<td align="center" valign="top">84</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Sequence Number</td>
</tr>
<tr>
<td align="center" valign="top">136</td>
<td align="center" valign="top">88</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum active</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">Current active</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">Maximum active jobs with priority 1</td>
</tr>
<tr>
<td align="center" valign="top">148</td>
<td align="center" valign="top">94</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum active jobs with priority 2</td>
</tr>
<tr>
<td align="center" valign="top">152</td>
<td align="center" valign="top">98</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum active jobs with priority 3</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">Maximum active jobs with priority 4</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">Maximum active jobs with priority 5</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">Maximum active jobs with priority 6</td>
</tr>
<tr>
<td align="center" valign="top">168</td>
<td align="center" valign="top">A8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum active jobs with priority 7</td>
</tr>
<tr>
<td align="center" valign="top">172</td>
<td align="center" valign="top">AC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum active jobs with priority 8</td>
</tr>
<tr>
<td align="center" valign="top">176</td>
<td align="center" valign="top">B0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum active jobs with priority 9</td>
</tr>
<tr>
<td align="center" valign="top">180</td>
<td align="center" valign="top">B4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active jobs with priority 0</td>
</tr>
<tr>
<td align="center" valign="top">184</td>
<td align="center" valign="top">B8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active jobs with priority 1</td>
</tr>
<tr>
<td align="center" valign="top">188</td>
<td align="center" valign="top">BC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active jobs with priority 2</td>
</tr>
<tr>
<td align="center" valign="top">192</td>
<td align="center" valign="top">C0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active jobs with priority 3</td>
</tr>
<tr>
<td align="center" valign="top">196</td>
<td align="center" valign="top">C4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active jobs with priority 4</td>
</tr>
<tr>
<td align="center" valign="top">200</td>
<td align="center" valign="top">C8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active jobs with priority 5</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">Active jobs with priority 6</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">Active jobs with priority 7</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">Active jobs with priority 8</td>
</tr>
<tr>
<td align="center" valign="top">216</td>
<td align="center" valign="top">D8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active jobs with priority 9</td>
</tr>
<tr>
<td align="center" valign="top">220</td>
<td align="center" valign="top">DC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Released jobs on queue with priority 0</td>
</tr>
<tr>
<td align="center" valign="top">224</td>
<td align="center" valign="top">E0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Released jobs on queue with priority 1</td>
</tr>
<tr>
<td align="center" valign="top">228</td>
<td align="center" valign="top">E4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Released jobs on queue with priority 2</td>
</tr>
<tr>
<td align="center" valign="top">232</td>
<td align="center" valign="top">E8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Released jobs on queue with priority 3</td>
</tr>
<tr>
<td align="center" valign="top">236</td>
<td align="center" valign="top">EC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Released jobs on queue with priority 4</td>
</tr>
<tr>
<td align="center" valign="top">240</td>
<td align="center" valign="top">F0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Released jobs on queue with priority 5</td>
</tr>
<tr>
<td align="center" valign="top">244</td>
<td align="center" valign="top">F4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Released jobs on queue with priority 6</td>
</tr>
<tr>
<td align="center" valign="top">248</td>
<td align="center" valign="top">F8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Released jobs on queue with priority 7</td>
</tr>
<tr>
<td align="center" valign="top">252</td>
<td align="center" valign="top">FC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Released jobs on queue with priority 8</td>
</tr>
<tr>
<td align="center" valign="top">256</td>
<td align="center" valign="top">100</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Released jobs on queue with priority 9</td>
</tr>
<tr>
<td align="center" valign="top">260</td>
<td align="center" valign="top">104</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Scheduled jobs on queue with priority 0</td>
</tr>
<tr>
<td align="center" valign="top">264</td>
<td align="center" valign="top">108</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Scheduled jobs on queue with priority 1</td>
</tr>
<tr>
<td align="center" valign="top">268</td>
<td align="center" valign="top">10C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Scheduled jobs on queue with priority 2</td>
</tr>
<tr>
<td align="center" valign="top">272</td>
<td align="center" valign="top">110</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Scheduled jobs on queue with priority 3</td>
</tr>
<tr>
<td align="center" valign="top">276</td>
<td align="center" valign="top">114</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Scheduled jobs on queue with priority 4</td>
</tr>
<tr>
<td align="center" valign="top">280</td>
<td align="center" valign="top">118</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Scheduled jobs on queue with priority 5</td>
</tr>
<tr>
<td align="center" valign="top">284</td>
<td align="center" valign="top">11C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Scheduled jobs on queue with priority 6</td>
</tr>
<tr>
<td align="center" valign="top">288</td>
<td align="center" valign="top">120</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Scheduled jobs on queue with priority 7</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">Scheduled jobs on queue with priority 8</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">Scheduled jobs on queue with priority 9</td>
</tr>
<tr>
<td align="center" valign="top">300</td>
<td align="center" valign="top">12C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Held jobs on queue with priority 0</td>
</tr>
<tr>
<td align="center" valign="top">304</td>
<td align="center" valign="top">130</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Held jobs on queue with priority 1</td>
</tr>
<tr>
<td align="center" valign="top">308</td>
<td align="center" valign="top">134</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Held jobs on queue with priority 2</td>
</tr>
<tr>
<td align="center" valign="top">312</td>
<td align="center" valign="top">138</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Held jobs on queue with priority 3</td>
</tr>
<tr>
<td align="center" valign="top">316</td>
<td align="center" valign="top">13C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Held jobs on queue with priority 4</td>
</tr>
<tr>
<td align="center" valign="top">320</td>
<td align="center" valign="top">140</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Held jobs on queue with priority 5</td>
</tr>
<tr>
<td align="center" valign="top">324</td>
<td align="center" valign="top">144</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Held jobs on queue with priority 6</td>
</tr>
<tr>
<td align="center" valign="top">328</td>
<td align="center" valign="top">148</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Held jobs on queue with priority 7</td>
</tr>
<tr>
<td align="center" valign="top">332</td>
<td align="center" valign="top">14C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Held jobs on queue with priority 8</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">Held jobs on queue with priority 9</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFD1XX">Field Descriptions</a></h3>
<p><strong>Active jobs with priority 0 through 9.</strong> The number of jobs
that are active for each priority level (0 through 9). If the subsystem name
and subsystem library name are blank, then this field is 0.</p>
<p><strong>Authority to check.</strong> Whether the user must be the owner of
the queue in order to control the queue by holding or releasing the queue. 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 job queue can control 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 job queue can control the queue.</td>
</tr>
</table>
<p><strong>Bytes available.</strong> Total format data length.</p>
<p><strong>Bytes returned.</strong> Length of the data returned.</p>
<p><strong>Current active.</strong> The current number of jobs that are active
that came through this job queue entry.</p>
<p><strong>Held jobs on queue with priority 0 through 9.</strong> The number of
jobs currently sitting on the job queue in *HELD status for each priority
level (0 through 9).</p>
<p><strong>Job queue library name.</strong> The name of the library that
contains the job queue.</p>
<p><strong>Job queue name.</strong> The name of the job queue.</p>
<p><strong>Job queue status.</strong> The status of the job queue. 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>
<p><strong>Maximum active.</strong> The maximum number of jobs that can be
active at the same time through this job queue entry. A -1 in this field
indicates that the value is *NOMAX.</p>
<p><strong>Maximum active jobs with priority 1 through 9.</strong> The maximum
number of jobs that can be active at the same time for each priority level (1
through 9). A -1 in this field indicates that the value is *NOMAX. If the
subsystem name and subsystem library name are blank, then this field is 0.</p>
<p><strong>Number of jobs.</strong> The number of jobs in the queue.</p>
<p><strong>Operator controlled.</strong> Whether a user who has job control
authority is allowed to control this job queue and manage the jobs on the
queue.</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 manage the jobs on the queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">This queue and its jobs cannot be controlled by
users with job control authority unless they also have other special
authority.</td>
</tr>
</table>
<p><strong>Released jobs on queue with priority 0 through 9.</strong> The
number of jobs currently sitting on the job queue in *RELEASED status for each
priority level (0 through 9).</p>
<p><strong>Scheduled jobs on queue with priority 0 through 9.</strong> The
number of jobs currently sitting on the job queue in *SCHEDULED status for each
priority level (0 through 9).</p>
<p><strong>Sequence number.</strong> The job queue entry sequence number. The
subsystem uses this number to determine the order in which job queues are
processed. Jobs from the queue with the lowest sequence number are processed
first.</p>
<p><strong>Subsystem name.</strong> The name of the subsystem that can receive
jobs from this job queue. If there is no name, then this queue is not
associated with an active subsystem, and no job can be processed.</p>
<p><strong>Subsystem library name.</strong> The library in which the subsystem
description resides. If there is no name, then this queue is not associated
with with an active subsystem and no job can be processed.</p>
<p><strong>Text description.</strong> Text that briefly describes the job
queue.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<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>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF1608 E</td>
<td align="left" valign="top">Subsystem description &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2207 E</td>
<td align="left" 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">CPF3307 E</td>
<td align="left" valign="top">Job queue &amp;1 in &amp;2 not found.</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">CPF8121 E</td>
<td align="left" valign="top">&amp;8 damage on job queue &amp;4 in library
&amp;9.</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">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</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 align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top">Top</a> | <a href="wm1.htm">
Work Management APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink