1165 lines
31 KiB
HTML
1165 lines
31 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 Threads (QWCOLTHD) 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. -->
|
|
<!-- Introducted in V5R2 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- File tagging cleanup completed Mar 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>Open List of Threads (QWCOLTHD) API</h2>
|
|
|
|
<div class="box" style="width: 90%;">
|
|
<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="15%">Output</td>
|
|
<td align="left" valign="top" width="25%">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">Receiver variable definition information</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Length of receiver variable definition
|
|
information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Job identification 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">Format of job identification information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</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">9</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">10</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">11</td>
|
|
<td align="left" valign="top">Number of fields 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">12</td>
|
|
<td align="left" valign="top">Key of fields to be returned</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Array(*) of Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">13</td>
|
|
<td align="left" valign="top">Reset status statistics</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">General return data</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">15</td>
|
|
<td align="left" valign="top">Length of general return data</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes.<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Open List of Threads (QWCOLTHD) API generates a list of active threads
|
|
for the job specified in the Job identification parameter. The list may be
|
|
sorted depending on the value of the sort parameter. 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>Authorities and Locks</h3>
|
|
|
|
None.
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The variable that is used to return the list of active thread
|
|
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 name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the thread list to be returned. The performance varies
|
|
depending on the number of fields selected. The possible format names
|
|
follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>OLTH0100</em></td>
|
|
<td align="left" valign="top">List of active threads with keyed return
|
|
fields.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>See <a href="#HDRLJOBRI">Format of Receiver Variable</a> for more
|
|
information.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Receiver variable definition information</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The variable that is used to return the description of how the keyed portion
|
|
of the list is returned in the receiver variable. See <a href="#HDRLJOBFI">
|
|
Format of Receiver Variable Definition Information</a> for a description of the
|
|
layout of this parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable definition information</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable definition information. This must be
|
|
large enough to hold the information for all key fields that are specified in
|
|
the key of fields to be returned parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Job identification information</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The information that is used to identify the job for which the list of
|
|
threads is to be returned. See <a href="#HDRXXJJJF1">Format of job
|
|
identification information</a> for details.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format of job identification information</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the job identification information. The possible format name
|
|
is:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>JIDF0100</em></td>
|
|
<td align="left" valign="top">See <a href="#HDRXXJJJF1">Format of job
|
|
identification information</a> for details on the job identification
|
|
information.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>List Information</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(80)
|
|
|
|
<p>Information about the list that is 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>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 after
|
|
sorting has been done.</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="#HDRLJOBSTI">Format of Sort Information</a> for a description of the
|
|
layout of this parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Number of fields to return</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number of fields to return. If this parameter is 0, the key of fields to
|
|
be returned parameter is not used, the receiver variable definition information
|
|
parameter is not modified, and the length of receiver variable definition
|
|
information must be 0.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Key of fields to be returned</strong></dt>
|
|
|
|
<dd>INPUT; ARRAY(*) of BINARY(4)
|
|
|
|
<p>The list of the fields to be returned. For a list of the valid key fields,
|
|
see <a href="#HDRLKEYS">Valid Keys</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Reset status statistics</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The elapsed time and all the key fields that are based on the elapsed time
|
|
are reset to zero. The following special values may be specified:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The elapsed time and the key fields based on the
|
|
elapsed time are not reset.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The elapsed time and the key fields based on the
|
|
elapsed time are reset back to zero.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>General return data</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>General output information that applies to the list of threads returned. See
|
|
<a href="#HDRGENDT">General return data</a> for a description of the data
|
|
returned.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of general return data</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the general output information. The general output information
|
|
field must be a minimum of 8 bytes.</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="HDRLJOBRI">Format of Receiver Variable</a></h3>
|
|
|
|
<p>The following tables describe the order and format of the data that is
|
|
returned in the receiver variable.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h4><a name="HDROLJBLS1">OLTH0100 Format</a></h4>
|
|
|
|
<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(8)</td>
|
|
<td align="left" valign="top" width="60%">Thread identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4), UNSIGNED</td>
|
|
<td align="left" valign="top">Thread handle</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Total length of data returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">F</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="2">This information repeats for each key
|
|
selected.</td>
|
|
<td align="left" valign="top">CHAR(*) or BINARY(4)</td>
|
|
<td align="left" valign="top">Data</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDROJBFD1">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Data.</strong> The data returned for the key field.</p>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>Thread handle.</strong> A value that is used to address a particular
|
|
thread within a job. A valid thread handle must be specified. The thread handle
|
|
is returned on several other interfaces.</p>
|
|
|
|
<p><strong>Thread identifier.</strong> A value that is used to uniquely
|
|
identify a thread within a job. A valid thread identifier must be
|
|
specified.</p>
|
|
|
|
<p><strong>Total length of data returned.</strong> The length of the data
|
|
portion of the returned data. This includes the sum of all the keyed data for
|
|
the list of threads.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRLJOBFI">Format of Receiver Variable Definition
|
|
Information</a></h3>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Number of fields returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" rowspan="6" colspan="2">These fields repeat, in
|
|
the order listed, for each key selected.</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of field information returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Key field</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Type of data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Displacement to data</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDROJBFD2">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Displacement to data.</strong> The displacement from the beginning
|
|
of the thread record in the receiver variable to the value for this key.</p>
|
|
|
|
<p><strong>Key field.</strong> The field returned. See <a href="#HDRLKEYS">List
|
|
of keys supported for format OLTH0100</a> for the list of valid keys supported
|
|
for the OLTH0100 format.</p>
|
|
|
|
<p><strong>Length of data.</strong> The length of the data returned for the
|
|
field.</p>
|
|
|
|
<p><strong>Length of field information returned.</strong> The total length of
|
|
definition information returned for this field. This value is used to increment
|
|
to the next field in the list.</p>
|
|
|
|
<p><strong>Number of fields returned.</strong> The number of fields in each
|
|
record that is returned to the application.</p>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>Type of data.</strong> The type of data that is returned.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>C</em></td>
|
|
<td align="left" valign="top">The data is returned in character format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>B</em></td>
|
|
<td align="left" valign="top">The data is returned in binary format.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRLJOBSTI">Format of Sort Information</a></h3>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">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>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRSRTFD">Field Descriptions</a></h3>
|
|
|
|
<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> Reserved field. This field must be set to
|
|
hexadecimal or binary zero.</p>
|
|
|
|
<p><strong>Sort key field data type.</strong> Data type of field to sort. Refer
|
|
to 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 to sort on. A value of 1
|
|
represents the first position within the record.</p>
|
|
|
|
<p><strong>Sort order.</strong> Whether the list should be sorted in ascending
|
|
or descending order according to the key.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Sort in ascending order.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Sort in descending order.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRXXJJJF1">Format of job identification information</a></h3>
|
|
|
|
<p>The format of the information needed to identify the job for which the list
|
|
of threads will be returned.</p>
|
|
|
|
<h4>JIDF0100 Format</h4>
|
|
|
|
<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 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">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">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(16)</td>
|
|
<td align="left" valign="top">Internal job identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">42</td>
|
|
<td align="center" valign="top">2A</td>
|
|
<td align="left" valign="top">CHAR(2)</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">Thread indicator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Thread identifier</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="Header_7">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Internal job identifier.</strong> The internal identifier for the
|
|
job. The List Job (QUSLJOB) API returns this identifier. If you do not specify
|
|
*INT for the job name parameter, this parameter must contain blanks. With this
|
|
parameter, the system can locate the job more quickly than with a job name.</p>
|
|
|
|
<p><strong>Job name.</strong> A specific job name or one of the following
|
|
special values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*</em></td>
|
|
<td align="left" valign="top">The job that this program is running in. The job
|
|
number and user name must contain blanks.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*INT</em></td>
|
|
<td align="left" valign="top">The internal job identifier locates the job. The
|
|
job number and user name must contain blanks.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Job number.</strong> A specific job number, or blanks when the job
|
|
name specified is a special value.</p>
|
|
|
|
<p><strong>Reserved.</strong> An unused field. This field must contain hex
|
|
zeros.</p>
|
|
|
|
<p><strong>Thread identifier.</strong> An unused field on this API. This field
|
|
must contain hex zeros.</p>
|
|
|
|
<p><strong>Thread indicator.</strong> An unused field on this API. This field
|
|
must contain hex zeros.</p>
|
|
|
|
<p><strong>User name.</strong> A specific user profile name, or blanks when the
|
|
job name specified is a special value.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRGENDT">General Return Data</a></h3>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Bytes returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
|
|
<td align="left" valign="top">Elapsed time</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Job name used</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">User name used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Job number used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">42</td>
|
|
<td align="center" valign="top">2A</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Internal job identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">58</td>
|
|
<td align="center" valign="top">3A</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="Header_20">Field Descriptions</a></h3>
|
|
|
|
<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>Elapsed time.</strong> The time, in milliseconds, that has elapsed
|
|
between the measurement start time and the current system time. This value is 0
|
|
the first time this API is called by this job. The measurement start is set the
|
|
first time this API is called and when the Reset status statistics is set to
|
|
reset the elapsed time.</p>
|
|
|
|
<p><strong>Internal job identifier.</strong> A value that is sent to other APIs
|
|
to speed the process of locating the job on the system. The identifier is not
|
|
valid following an initial program load (IPL). If you attempt to use it after
|
|
an IPL, an exception occurs.</p>
|
|
|
|
<p><strong>Job name used.</strong> The name of the job as identified to the
|
|
system. For an interactive job, the system assigns the job the name of the
|
|
workstation where the job started. For a batch job, you specify the name in the
|
|
command when you submit the job.</p>
|
|
|
|
<p><strong>Job number used.</strong> The system-assigned job number.</p>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>User name used.</strong> The user profile under which the job is
|
|
started. The user name is the same as the user profile name and can come from
|
|
several different sources depending on the type of job.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRLKEYS">List of keys supported for format OLTH0100</a></h3>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="top">Key</th>
|
|
<th align="left" valign="top">Type</th>
|
|
<th align="left" valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="15%">305</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="65%">Current user profile</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">319</td>
|
|
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
|
|
<td align="left" valign="top">Processing unit time used - total for the
|
|
thread</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">320</td>
|
|
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
|
|
<td align="left" valign="top">Processing unit time used for database - total
|
|
for the thread</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">321</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Processing unit used - percent during the elapsed
|
|
time (thread)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">322</td>
|
|
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
|
|
<td align="left" valign="top">Processing unit used - time during the elapsed
|
|
time (thread)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">323</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Processing unit used for database - percent used
|
|
during the elapsed time (thread)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">324</td>
|
|
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
|
|
<td align="left" valign="top">Processing unit time used for data base - time
|
|
during the elapsed time (thread)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">419</td>
|
|
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
|
|
<td align="left" valign="top">Disk I/O count during the elapsed time
|
|
(thread)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">420</td>
|
|
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
|
|
<td align="left" valign="top">Disk I/O count - total for the thread</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">421</td>
|
|
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
|
|
<td align="left" valign="top">Disk I/O count during the elapsed time -
|
|
asynchronous I/O (thread)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">422</td>
|
|
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
|
|
<td align="left" valign="top">Disk I/O count during the elapsed time -
|
|
synchronous I/O (thread)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">1610</td>
|
|
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
|
|
<td align="left" valign="top">Page fault count during the elapsed time
|
|
(thread)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">1804</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Run priority (thread)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2010</td>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Thread status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2011</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Thread type</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>When the length of the data returned for a key is not a multiple of 4 bytes,
|
|
the length of the field information returned is adjusted so that the next key
|
|
begins on a 4-byte boundary. This adjustment should be considered when
|
|
calculating the starting position of a key field to sort on.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDROJBFD4">Field Descriptions</a></h3>
|
|
|
|
<p>The field descriptions are in <a href="../apis/WMAttrDesc.htm">Work
|
|
Management API Attribute Descriptions (WMAttrDesc)</a>.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF136A E</td>
|
|
<td align="left" valign="top">Job &3/&2/&1 not active.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF1866 E</td>
|
|
<td align="left" valign="top">Value &1 for number of fields to return not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF1867 E</td>
|
|
<td align="left" valign="top">Value &1 in list not valid.</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">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">CPF3C3B E</td>
|
|
<td align="left" valign="top">Value for parameter &2 for API &1 not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C3C E</td>
|
|
<td align="left" valign="top">Value for parameter &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C51 E</td>
|
|
<td align="left" valign="top">Internal job identifier not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C52 E</td>
|
|
<td align="left" valign="top">Internal job identifier no longer valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C53 E</td>
|
|
<td align="left" valign="top">Job &3/&2/&1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C58 E</td>
|
|
<td align="left" valign="top">Job name specified is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C59 E</td>
|
|
<td align="left" valign="top">Internal identifier is not blanks and job name is
|
|
not *INT.</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">CPF3CF2 E</td>
|
|
<td align="left" valign="top">Error(s) occurred during running of &1
|
|
API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9F81 E</td>
|
|
<td align="left" valign="top">API &1 requires too much information to be
|
|
collected prior to sorting.</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">GUI0132 E</td>
|
|
<td align="left" valign="top">&2 is not valid for length of receiver
|
|
variable definition information.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">GUI0149 E</td>
|
|
<td align="left" valign="top">&1 is not valid for number of keys to sort
|
|
on.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V5R2
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"wm1.htm">Work Management APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|