855 lines
25 KiB
HTML
855 lines
25 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Open List of Job Queues (QSPOLJBQ) API</title>
|
||
|
|
<!-- Begin Header Records ========================================= -->
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Created for V5R1 -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- File cleanup completed Dec 2001 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>Open List of Job Queues (QSPOLJBQ) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="50%">Receiver variable</td>
|
||
|
|
<td align="left" valign="top" width="20%">Output</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Length of receiver variable</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Format of receiver variable</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">List information</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(80)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">Filter information</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</td>
|
||
|
|
<td align="left" valign="top">Sort information</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="left" valign="top">Number of records to return</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</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>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Open List of Job Queues (QSPOLJBQ) API generates a list of job queues on
|
||
|
|
the system. The list can include all job queues on the system, all job queues
|
||
|
|
for a specified library list, the allocated job queues for a specified active
|
||
|
|
subsystem, or the defined job queues for a specified active subsystem (this
|
||
|
|
would include both the allocated job queues and the job queues the subsystem
|
||
|
|
could not allocate), or all the allocated job queues for all the active
|
||
|
|
subsystems. The filtered list can then be sorted depending on the value of the
|
||
|
|
sort parameter. When requesting job queue information for all job queues on the
|
||
|
|
system or for a specific job queue within a library, if the signed-on user is
|
||
|
|
not authorized to the library of the job queue, information for that job queue
|
||
|
|
in not returned by this API. When requesting the job queue information for job
|
||
|
|
queues defined to an active subsystem, all job queue information will be
|
||
|
|
returned with out regard to the users authority to the subsystem. Upon
|
||
|
|
successful completion of this API, a handle is returned in the list information
|
||
|
|
parameter. You may use this handle on subsequent calls to the following
|
||
|
|
APIs:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dd>Get List Entries (QGYGTLE)</dd>
|
||
|
|
|
||
|
|
<dd>Find List Entry (QGYFNDE)</dd>
|
||
|
|
|
||
|
|
<dd>Close List (QGYCLST)</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Performance Impacts</h3>
|
||
|
|
|
||
|
|
<p>Sorting on one or more values of job queue name, job queue library name, job
|
||
|
|
queue status, subsystem name, subsystem library name, number of jobs on job
|
||
|
|
queue, sequence number, maximum active, current active or description takes
|
||
|
|
more processing power and time.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Job Queue Library Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*EXECUTE</dd>
|
||
|
|
|
||
|
|
<dt><em>Job Queue Lock</em></dt>
|
||
|
|
|
||
|
|
<dd>This API gets an *EXCLRD lock on the job queue.</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 used to return the job queue information.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the receiver variable.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format of receiver variable</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the job queue information being returned. You can specify the
|
||
|
|
following:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>OJBQ0100</em></td>
|
||
|
|
<td align="left" valign="top">Contains the basic information about the job
|
||
|
|
queue. For more information about the OJBQ0100 format,
|
||
|
|
see <a href="#HDRLJBQ100">Format of Receiver Variable</a>.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>List information</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(80)
|
||
|
|
|
||
|
|
<p>Information about the list created by this program. For a description of the
|
||
|
|
layout of this parameter, see <a href="../apiref/oli.htm">Format of open list
|
||
|
|
information</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Filter information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The information in this parameter is used for filtering the list of job
|
||
|
|
queue information. For more information about the filter information, see
|
||
|
|
<a href="#HDRLFILTER">Filter Information</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Sort information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>Information on what fields within the record of information to sort. See <a
|
||
|
|
href="#HDRLSORT">Format of Sort Information</a> for a description of the layout
|
||
|
|
of this parameter. Note that when sorting is requested, the entire list has to
|
||
|
|
be built and sorted before any records can be returned.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Number of records to return</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The number of records in the list to put into the receiver variable.</p>
|
||
|
|
|
||
|
|
<p>If -1 is specified for this parameter, the entire list is built
|
||
|
|
synchronously.</p>
|
||
|
|
|
||
|
|
<p>If 0 is specified for this parameter, the entire list is built
|
||
|
|
asynchronously in a server job.</p>
|
||
|
|
|
||
|
|
<p>If a positive number of records to return is specified, at least that many
|
||
|
|
records are built synchronously and the remainder are built asynchronously in a
|
||
|
|
server job.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; CHAR(*)
|
||
|
|
|
||
|
|
<p>The structure in which to return error information. For the format of the
|
||
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRLFILTER">Filter Information</a></h3>
|
||
|
|
|
||
|
|
<p>The following table shows the format of the filter information parameter.
|
||
|
|
For detailed descriptions of the fields in the table, see
|
||
|
|
<a href= "#HDRGYFILTD">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%">Length of filter information</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</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">14</td>
|
||
|
|
<td align="center" valign="top">E</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">24</td>
|
||
|
|
<td align="center" valign="top">18</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Active subsystem name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">34</td>
|
||
|
|
<td align="center" valign="top">22</td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRLSORT">Format of Sort Information</a></h3>
|
||
|
|
|
||
|
|
<p>For more details about the fields in the following table, see
|
||
|
|
<a href="#HDRGYFILTD">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 keys to sort on</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" rowspan="5" colspan="2">Offsets vary. These
|
||
|
|
fields repeat for each sort key field.</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Sort key field starting position</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Sort key field length</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(2)</td>
|
||
|
|
<td align="left" valign="top">Sort key field data type</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Sort order</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> If the last three fields (sort key field data type,
|
||
|
|
sort order, and the reserved field) are not used, then they must be set to
|
||
|
|
hexadecimal zeros. This causes all the data to be treated as character data,
|
||
|
|
and it is sorted in ascending order.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRGYFILTD">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Active subsystem name.</strong> The active subsystem name whose job
|
||
|
|
queue information is to be returned. A simple active subsystem name or one of
|
||
|
|
the following special values may be specified.</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" nowrap><em>simple name</em></td>
|
||
|
|
<td align="left" valign="top">A simple name of an active subsystem. The job
|
||
|
|
queue name field must be set to special value *ALLOCATED or *DEFINED.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">All allocated job queues for all active
|
||
|
|
subsystems on the system are returned. The Job queue name field must be set to
|
||
|
|
the special value *ALLOCATED.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>blanks</em></td>
|
||
|
|
<td align="left" valign="top">The active subsystem name field is ignored. Only
|
||
|
|
the job queue name field is used.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>If the active subsystem field is used, the job queue name field must be set
|
||
|
|
to the correct special value and the job queue library name field must be set
|
||
|
|
to blanks.</p>
|
||
|
|
|
||
|
|
<p><strong>Job queue name.</strong> The job queue about which to retrieve
|
||
|
|
information. A simple job queue name, a generic job queue name, or a special
|
||
|
|
value may be specified.</p>
|
||
|
|
|
||
|
|
<p>The following values require the active subsystem name field to be
|
||
|
|
blank.</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>simple name</em></td>
|
||
|
|
<td align="left" valign="top">A simple name of a job queue.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" nowrap><em>generic name</em></td>
|
||
|
|
<td align="left" valign="top">A generic name for job queues.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">All job queues are returned.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>When the active subsystem name field is set to a simple subsystem name, then
|
||
|
|
one of the following special values must be used:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALLOCATED</em></td>
|
||
|
|
<td align="left" valign="top">Only the job queues that have been allocated by
|
||
|
|
the active subsystem are returned.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*DEFINED</em></td>
|
||
|
|
<td align="left" valign="top">The job queues that are defined to the active
|
||
|
|
subsystem. This includes the job queues that have been allocated by the
|
||
|
|
subsystem.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>When the active subsystem name field is set to *ALL, the following special
|
||
|
|
value must be used:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALLOCATED</em></td>
|
||
|
|
<td align="left" valign="top">Only the job queues that have been allocated by
|
||
|
|
the active subsystem name are returned.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Job queue library name.</strong> The library in which the job queue
|
||
|
|
is located. A specific library name or a special value may be specified.</p>
|
||
|
|
|
||
|
|
<p>The following values apply only when the job queue name field is set to a
|
||
|
|
simple job queue name, a generic job queue name, or the special value *ALL.</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>simple name</em></td>
|
||
|
|
<td align="left" valign="top">A simple name of a library.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">All libraries on the system are searched.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALLUSR</em></td>
|
||
|
|
<td align="left" valign="top">All user defined libraries to which the user is
|
||
|
|
authorized are searched. For information on the
|
||
|
|
libraries included, see <a href="../apiref/genericlibname.htm#allusr">*ALLUSR</a> in Generic library names.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
||
|
|
<td align="left" valign="top">The job's current library is searched.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
||
|
|
<td align="left" valign="top">The library list for the job is searched.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*USRLIBL</em></td>
|
||
|
|
<td align="left" valign="top">The libraries in the user portion of the job's
|
||
|
|
library list are searched.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>When the job queue name field is set to *ALLOCATED or *DEFINED the the job
|
||
|
|
queue library field must be blanks.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of filter information.</strong> The length of the filter
|
||
|
|
information. An error message is returned if the length of filter information
|
||
|
|
is not set correctly.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of keys to sort on.</strong> The number of fields within the
|
||
|
|
record structure on which to sort. If 0 is specified, the list is not
|
||
|
|
sorted.</p>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> Must be set to hexadecimal zeros.</p>
|
||
|
|
|
||
|
|
<p><strong>Sort key field data type.</strong> Data type of field to sort. See
|
||
|
|
the <a href="QLGSORT.htm">Sort</a> (QLGSORT) API for information on the list of
|
||
|
|
data types available.</p>
|
||
|
|
|
||
|
|
<p><strong>Sort key field length.</strong> The length of the field on which to
|
||
|
|
sort.</p>
|
||
|
|
|
||
|
|
<p><strong>Sort key field starting position.</strong> Within the record of
|
||
|
|
information, the starting position of the field on which to sort.</p>
|
||
|
|
|
||
|
|
<p><strong>Sort order.</strong> Whether the list should be sorted in ascending
|
||
|
|
or descending order according to the key. See the <a href="QLGSORT.htm">Sort</a>
|
||
|
|
(QLGSORT) API for information on the sort order special values.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRLJBQ100">Format of Receiver Variable</a></h3>
|
||
|
|
|
||
|
|
<p>The following tables describe the order and format of the data returned in
|
||
|
|
the receiver variable.</p>
|
||
|
|
|
||
|
|
<h4><a name="HDRLSPL100">OJBQ0100 Format</a></h4>
|
||
|
|
|
||
|
|
<p>For more details about the fields in the following table, see
|
||
|
|
<a href="#HDRABFD">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%">Job queue 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">Job queue library name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">20</td>
|
||
|
|
<td align="center" valign="top">14</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Job queue status</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">21</td>
|
||
|
|
<td align="center" valign="top">15</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Subsystem name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">31</td>
|
||
|
|
<td align="center" valign="top">15</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">41</td>
|
||
|
|
<td align="center" valign="top">29</td>
|
||
|
|
<td align="left" valign="top">CHAR(3)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">44</td>
|
||
|
|
<td align="center" valign="top">2C</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of jobs on job queue</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">Sequence number</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">52</td>
|
||
|
|
<td align="center" valign="top">34</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Maximum active</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">56</td>
|
||
|
|
<td align="center" valign="top">38</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Current active</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">60</td>
|
||
|
|
<td align="center" valign="top">3C</td>
|
||
|
|
<td align="left" valign="top">CHAR(50)</td>
|
||
|
|
<td align="left" valign="top">Description</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRABFD">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Current active.</strong> The number of jobs currently running in the
|
||
|
|
active subsystem from this job queue. This field is -1 if the job queue is not
|
||
|
|
allocated, is damaged, does not exist, or the job queue has not been allocated
|
||
|
|
by the subsystem that was specified in the active subsystem field in the filter
|
||
|
|
parameter.</p>
|
||
|
|
|
||
|
|
<p><strong>Description.</strong> The text description for this job queue. This
|
||
|
|
field will be blank if the job queue is defined to an active subsystem, but has
|
||
|
|
not been created or the job queue is damaged.</p>
|
||
|
|
|
||
|
|
<p><strong>Job queue library name.</strong> The name of the library in which
|
||
|
|
the job queue is located.</p>
|
||
|
|
|
||
|
|
<p><strong>Job queue name.</strong> The name of the job queue.</p>
|
||
|
|
|
||
|
|
<p><strong>Job queue status.</strong> The current status of the job queue. 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">The job queue is currently held. No jobs can
|
||
|
|
become active from this job queue.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The job queue is released. Jobs can become active
|
||
|
|
from this queue.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">The job queue is damaged.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>3</em></td>
|
||
|
|
<td align="left" valign="top">The job queue is defined to the active subsystem,
|
||
|
|
but has not been created. No jobs can become active from this job queue until
|
||
|
|
it is created.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Maximum active.</strong> The maximum number of jobs that can be
|
||
|
|
active in the subsystem from this job queue at one time. A -1 in this field
|
||
|
|
indicates that the value is *NOMAX. This field is -2 if the job queue has not
|
||
|
|
been defined to an active subsystem or the job queue is damaged.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of jobs on job queue.</strong> The total number of jobs
|
||
|
|
currently waiting to run on this job queue. This field ise -1 if the job queue
|
||
|
|
is defined to the active subsystem, but has not been created or the job queue
|
||
|
|
is damaged.</p>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> A reserved field.</p>
|
||
|
|
|
||
|
|
<p><strong>Sequence number.</strong> The job queue entry sequence number. The
|
||
|
|
subsystem uses this number to determine the order in which the job queues are
|
||
|
|
processed. Jobs from the job queue with the lowest sequence number in the job
|
||
|
|
queue are selected first. This field is -1 if the job queue has not been
|
||
|
|
defined to an active subsystem or the job queue is damaged.</p>
|
||
|
|
|
||
|
|
<p><strong>Subsystem name.</strong> The name of the subsystem to which this job
|
||
|
|
queue is allocated. If the job queue has been allocated by a different
|
||
|
|
subsystem than was specified in the filter parameter, the subsystem name will
|
||
|
|
identify the subsystem to which the job queue is allocated. This field is blank
|
||
|
|
if the job queue is not allocated, is damaged, or does not exist.</p>
|
||
|
|
|
||
|
|
<p><strong>Subsystem library name.</strong> The library in which the subsystem
|
||
|
|
description resides. This field will be blank if the job queue is not
|
||
|
|
allocated, damaged or does not exist.</p>
|
||
|
|
|
||
|
|
<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">CPF1054 E</td>
|
||
|
|
<td align="left" valign="top">No subsystem &1 active.</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 &1 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">CPF3CF1 E</td>
|
||
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9804 E</td>
|
||
|
|
<td align="left" valign="top">Object &2 in library &3 damaged.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9820 E</td>
|
||
|
|
<td align="left" valign="top">Not authorized to use library &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9830 E</td>
|
||
|
|
<td align="left" valign="top">Cannot assign library &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9871 E</td>
|
||
|
|
<td align="left" valign="top">Error occurred while processing.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9872 E</td>
|
||
|
|
<td align="left" valign="top">Program or service program &1 in library
|
||
|
|
&2 ended. Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">GUI0002 E</td>
|
||
|
|
<td align="left" valign="top">&2 is not valid for length of receiver
|
||
|
|
variable.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">GUI0024 E</td>
|
||
|
|
<td align="left" valign="top">&1 is not valid for number of keys to sort
|
||
|
|
on.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">GUI0025 E</td>
|
||
|
|
<td align="left" valign="top">&1 is not valid for sort key field starting
|
||
|
|
position.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">GUI0026 E</td>
|
||
|
|
<td align="left" valign="top">&1 is not valid for sort key field
|
||
|
|
length.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">GUI0027 E</td>
|
||
|
|
<td align="left" valign="top">&1 is not valid for number of records to
|
||
|
|
return.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">GUI0119 E</td>
|
||
|
|
<td align="left" valign="top">Reserved field in sort information not
|
||
|
|
valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">GUI0120 E</td>
|
||
|
|
<td align="left" valign="top">Order field in sort information not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">GUI0150 E</td>
|
||
|
|
<td align="left" valign="top">Subsystem key must be specified.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">GUI0152 E</td>
|
||
|
|
<td align="left" valign="top">&1 is not valid for length of filter
|
||
|
|
information.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R1
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|