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

1266 lines
35 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Retrieve Current Attributes (QWCRTVCA) 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 Nov 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>Retrieve Current Attributes (QWCRTVCA) 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="45%">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">Number of attributes 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">5</td>
<td align="left" valign="top">Key of attributes 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">6</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: Conditional; see <a href="#HDRLKEYS3">Valid Key
Attributes</a>.<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Retrieve Current Attributes (QWCRTVCA) API retrieves job and thread
attributes that apply to the thread in which this API is called. If a thread
attribute exists, it is retrieved. If a thread attribute does not exist, the
job attribute for the job in which this thread is running is retrieved.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The variable that is used to return the thread attributes.</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 attribute list to return. The possible format names
follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top">
<em>RTVC0100</em></td>
<td align="left" valign="top">Basic retrieve format</td>
</tr>
<tr>
<td align="left" valign="top"><em>RTVC0200</em></td>
<td align="left" valign="top">Library list information</td>
</tr>
<tr>
<td align="left" valign="top"><em>RTVC0300</em></td>
<td align="left" valign="top">ASP group information</td>
</tr>
</table>
<p>See <a href="#HDRFMT100">RTVC0100 Format</a>, <a href="#HDRFMT200">RTVC0200
Format</a>, and <a href="#HDRFMT300">RTVC0300 Format</a> for more
information.</p>
</dd>
<dt><strong>Number of attributes to return</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of attributes to return in the specified format.</p>
</dd>
<dt><strong>Key of attributes to be returned</strong></dt>
<dd>INPUT; ARRAY(*) of BINARY(4)
<p>The list of the attributes to be returned in the specified format. For a
list of the valid key attributes, see <a href="#HDRLKEYS3">Valid Key
Attributes</a>.</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="HDRFMT100">RTVC0100 Format</a></h3>
<p>The following table describes the order and format of the data that is
returned in the receiver variable for format RTVC0100. See <a href=
"#HDRLKEYS3">Valid Key Attributes</a> for threadsafe information.</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 attributes returned</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="7" colspan="2">These fields repeat, in
the order listed, for each key requested.</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of attribute information returned</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Key</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">CHAR(*)</td>
<td align="left" valign="top">Data</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="Header_193">Field Descriptions</a></h3>
<p><strong>Data.</strong> The data returned for the key field.</p>
<p><strong>Key.</strong> The attribute returned. See <a href="#HDRLKEYS3">Valid
Key Attributes</a> for the list of valid keys.</p>
<p><strong>Length of attribute information returned.</strong> The total length
of information returned for this attribute. This value is used to increment to
the next entry in the list.</p>
<p><strong>Length of data.</strong> The length of the data returned for the
field.</p>
<p><strong>Number of attributes returned.</strong> The number of attributes
returned to the application.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Type of data.</strong> The type of output data. This field is
provided to maintain the same format layout that is used in the Change Job
(QWTCHGJB) API.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">The output data is in character format.</td>
</tr>
<tr>
<td align="left" valign="top"><em>B</em></td>
<td align="left" valign="top">The output data is in binary format.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFMT200">RTVC0200 Format</a></h3>
<p>The RTVC0200 format returns library list information. Retrieval of the
library list information is threadsafe. The format returns the actual length
instead of the total length because all libraries may not exist.<br>
</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 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">Number of 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(4)</td>
<td align="left" valign="top">Number of libraries in SYSLIBL</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">Number of product libraries</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Current library existence</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of libraries in USRLIBL</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">Array(*) of CHAR(11)</td>
<td align="left" valign="top">Library list (for each library in the list)</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The decimal
and hexadecimal offsets depend on the number of libraries you have in the
various parts of your library lists and on keys requested. The data is
left-justified and padded with blanks on the right. The array is sequential.
See the <a href="../rbam6/clpro.htm">CL Programming</a> topic for the total
number of libraries that can be returned to you.</td>
</tr>
</table>
<br>
<br>
<h3><a name="Header_195">Field Descriptions</a></h3>
<p><strong>Current library existence.</strong> Whether the current library
exists or not. This value will be zero if the current library was not
requested.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No current library exists.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A current library exists.</td>
</tr>
</table>
<p><strong>Number of bytes available.</strong> All of the available bytes for
use in your application.</p>
<p>The actual length depends on how many libraries are in the library list.</p>
<p><strong>Number of bytes returned.</strong> The number of bytes returned to
the user. This may be some but not all of the bytes available.</p>
<p><strong>Number of libraries in SYSLIBL.</strong> The number of libraries in
the system part of the thread's library list. This value will be zero if system
libraries were not requested.</p>
<p><strong>Number of libraries in USRLIBL.</strong> The number of libraries in
the thread's user library list. This value will be zero if user libraries were
not requested.</p>
<p><strong>Number of product libraries.</strong> The number of product
libraries found in the thread's library list. This value will be zero if
product libraries were not requested.</p>
<p><strong>Library list (for each library in the list).</strong> The list of
all libraries requested. A blank is in the last position of each name. The
number of libraries in the list will depend on the keys requested and the
actual number of libraries in each portion of the library list. The order of
the library list is:</p>
<ul>
<li>System library list</li>
<li>Product libraries</li>
<li>Current library</li>
<li>User library list</li>
</ul>
<br>
<h3><a name="HDRFMT300">RTVC0300
Format</a></h3>
<p>The RTVC0300 format returns auxiliary storage pool (ASP) group information.
Retrieval of the ASP group information is threadsafe.</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 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">Number of 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(4)</td>
<td align="left" valign="top">Offset to ASP group information</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">Number of entries in ASP group information</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of one ASP group information entry</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">Array(*) of CHAR(*)</td>
<td align="left" valign="top">ASP group information entry (See <a href=
"#HDRASPLE">Format of ASP Group Information Entry</a> for more
information.)</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> This field
repeats for each ASP group information entry. For additional information, see
the Control Language (CL) information for the <a href="../cl/setaspgrp.htm">Set
ASP Group (SETASPGRP)</a> command.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFLD300">Field Descriptions</a></h3>
<p><strong>ASP group information entry.</strong> The auxiliary storage pool
(ASP) group information requested. This does not include the system ASP or the
basic user ASP.</p>
<p><strong>Length of one ASP group information entry.</strong> The length of
one ASP group information entry.</p>
<p><strong>Number of ASP group information entries</strong> The number of ASP
group information entries being returned.</p>
<p><strong>Number of bytes available.</strong> The number of available bytes
for use by your application.</p>
<p><strong>Number of bytes returned.</strong> The number of bytes returned to
the user. This may be some but not all of the bytes available.</p>
<p><strong>Offset to ASP group information</strong> The offset in characters
(bytes) from the beginning of the receiver to the first ASP group information
entry.</p>
<br>
<h3><a name="HDRASPLE">Format of ASP Group Information Entry</a></h3>
<p>The ASP group information entry describes the data that is returned for each
ASP group of the RTVC0300 format.</p>
<table border width="80%">
<!-- cols="10 10 20 60" -->
<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="left" valign="top" rowspan="3" colspan="2" width="20%">These fields
repeat for each entry returned in the list.</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">ASP group name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<h3><a name="HDRFLD3001">Field Descriptions</a></h3>
<p><strong>ASP group name</strong> The name of the ASP group. This is the name
of the primary ASP device in an ASP group.</p>
<br>
<br>
<h3><a name="HDRLKEYS3">Valid Key Attributes</a></h3>
<p>The following table contains a list of the valid keys for format RTVC0100.
In addition, the table indicates whether the attributes are threadsafe. See <a
href="#HDRJOBRDE2">Key Field Descriptions</a> for the descriptions of the valid
key attributes.</p>
<table border>
<tr>
<th align="left" valign="bottom">Key</th>
<th align="left" valign="bottom">Type</th>
<th align="left" valign="bottom">Description</th>
<th align="left" valign="bottom">Threadsafe<br>
(See Note)</th>
</tr>
<tr>
<td align="left" valign="top" width="10%">0102</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Allow multiple threads</td>
<td align="left" valign="top" width="20%">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0201</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Break message handling</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0301</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Cancel key</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0302</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Coded character set ID</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0303</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Country or region ID</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0305</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Current user profile</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0307</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Current system pool identifier</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0311</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Character identifier control</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0401</td>
<td align="left" valign="top">CHAR(13)</td>
<td align="left" valign="top">Date and time job became active</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0402</td>
<td align="left" valign="top">CHAR(13)</td>
<td align="left" valign="top">Date and time job entered system</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0403</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Date and time job was scheduled to run</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0405</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Date format</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0406</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Date separator</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0407</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">DBCS-capable</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0408</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">DDM conversation handling</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0409</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Default wait</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0410</td>
<td align="left" valign="top">CHAR(13)</td>
<td align="left" valign="top">Device recovery action</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0412</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Default coded character set identifier</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0413</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Decimal format</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0501</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">End severity</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0502</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">End status</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0503</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Exit key</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0702</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Group profile name</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0703</td>
<td align="left" valign="top">CHAR(150)</td>
<td align="left" valign="top">Group profile name - supplemental</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0901</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Inquiry message reply</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0902</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Internal job ID</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">0903</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Initial thread</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1001</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Job accounting code</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1002</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Job date</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1004</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Job queue name - qualified</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1005</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Job queue priority</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1006</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Job switches</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1007</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job message queue full action</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1008</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Job message queue maximum size</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1009</td>
<td align="left" valign="top">CHAR(26)</td>
<td align="left" valign="top">Job name</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1010</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Job type</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1011</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Job subtype</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1017</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Job local time</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">
<img src="delta.gif" alt="Start of change">1018</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job log output</td>
<td align="left" valign="top">Yes
<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="left" valign="top">1201</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Language ID</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1202</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Logging level</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1203</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Logging of CL programs</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1204</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Logging severity</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1205</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Logging text</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1304</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum threads</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1501</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Output queue name - qualified</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1502</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Output queue priority</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1601</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Print key format</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1602</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Print text</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1603</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Printer device name</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1604</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Purge</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1802</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Run priority</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1901</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Sort sequence table - qualified</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1902</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Status message handling</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1904</td>
<td align="left" valign="top">CHAR(26)</td>
<td align="left" valign="top">Submitter's job name - qualified</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1905</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Submitter's message queue name - qualified</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1907</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">System pool identifier</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1982</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Spooled file action</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2001</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Time separator</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2002</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Time slice</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2003</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Time-slice end pool</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2008</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Thread count</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2020</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Time zone current abbreviated name</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2021</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Time zone current full name</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2022</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Time zone current message identifier</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2023</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Time zone current offset</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2024</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Time zone description name</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2025</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Time zone message file name - qualified</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2026</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Time zone Daylight Saving Time indicator</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" colspan="4" valign="top"><strong>Note:</strong>If this value
is blank, the attribute is not threadsafe.</td>
</tr>
</table>
<p>The following table contains a list of the valid keys for format RTVC0200.
In addition, the table indicates whether the attributes are threadsafe. See <a
href="#HDRJOBRDE2">Key Field Descriptions</a> for the descriptions of the valid
key attributes.</p>
<table border>
<tr>
<th align="left" valign="bottom">Key</th>
<th align="left" valign="bottom">Type</th>
<th align="left" valign="bottom">Description</th>
<th align="left" valign="bottom">Threadsafe<br>
(See Note)</th>
</tr>
<tr>
<td align="left" valign="top" width="10%">0310</td>
<td align="left" valign="top" width="25%">CHAR(11)</td>
<td align="left" valign="top" width="45%">Current library</td>
<td align="left" valign="top" width="20%">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1660</td>
<td align="left" valign="top">Array(*) of CHAR(11)</td>
<td align="left" valign="top">Product libraries</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">1980</td>
<td align="left" valign="top">Array(*) of CHAR(11)</td>
<td align="left" valign="top">System library list</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2110</td>
<td align="left" valign="top">Array(*) of CHAR(11)</td>
<td align="left" valign="top">User library list</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top">2702</td>
<td align="left" valign="top">Array(*) of CHAR(11)</td>
<td align="left" valign="top">All portions of the library list for format
RTVC0200</td>
<td align="left" valign="top">Yes</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> If this value
is blank, the attribute is not threadsafe.</td>
</tr>
</table>
<p>The following table contains
a list of the valid keys for format RTVC0300. In addition, the table indicates
whether the attributes are threadsafe. See <a href="#HDRJOBRDE2">Key Field
Descriptions</a> for the descriptions of the valid key attributes.</p>
<table border width="80%">
<tr>
<th align="left" valign="bottom">Key</th>
<th align="left" valign="bottom">Type</th>
<th align="left" valign="bottom">Description</th>
<th align="left" valign="bottom">Threadsafe<br>
(See Note)</th>
</tr>
<tr>
<td align="left" valign="top" width="10%">0104</td>
<td align="left" valign="top" width="20%">CHAR(*)</td>
<td align="left" valign="top" width="50%">ASP group information</td>
<td align="left" valign="top" width="20%">Yes</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRJOBRDE2">Key Field Descriptions</a></h3>
<p>Most field descriptions for
this API are in <a href="WMAttrDesc.htm"> Work Management API Attribute
Descriptions (WMAttrDesc)</a>, except the following:</p>
<p><strong>All portions of the library list for format RTVC0200.</strong> All
portions of the library list will be returned.</p>
<p><strong>Current system pool identifier.</strong> The identifier of the
system-related pool from which this thread's main storage currently is being
allocated. These identifiers are not the same as those specified in the
subsystem description, but are the same as the system pool identifiers shown on
the system status display. If a thread reaches the end of its time slice, the
pool this thread is running in can be switched based on the job's time-slice
end pool value. The current system pool identifier returned by this API will be
the actual pool in which the thread currently is running.</p>
<p><strong>Run
priority.</strong> The priority at which this thread currently is running,
relative to other threads on the system. The run priority ranges from 0
(highest priority) to 99 (lowest priority). The value may never be higher than
the run priority for the job in which this thread is running. Since this API is
intended for retrieving the current value of an attribute, the run priority of
the thread is returned, even though the 1802 key represents the run priority of
the job on other interfaces. To obtain the run priority of the job, use the
1802 key on the <a href="qwtrtvta.htm"> Retrieve Thread Attributes</a>
(QWTRTVTA) API.</p>
<br>
<h3>Error Messages</h3>
<table width="100%">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top" width="15%">CPF1866 E</td>
<td align="left" valign="top" width="85%">Value &amp;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 &amp;1 in list not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1D E</td>
<td align="left" valign="top">Length specified in parameter &amp;1 not
valid.</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">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this
API was 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">
CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</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: V4R2
<hr>
<center>
<table 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>
</center>
</body>
</html>
Reference in New Issue Copy Permalink