1350 lines
39 KiB
HTML
1350 lines
39 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>List Requested Statistics Collections (QDBSTLRS,
|
||
|
|
QdbstListRequestedStatistics) 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. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- Created by Ulrich Thiemann on 03-May-2001 -->
|
||
|
|
<!-- Updated by Ulrich Thiemann on 01-Aug-2002 -->
|
||
|
|
<!-- 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>List Requested Statistics Collections (QDBSTLRS, QdbstListRequestedStatistics) 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%">Qualified user space name</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(20)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Format of output</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Input data</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Length of input data</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">Format of input data</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(8)</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>
|
||
|
|
Service Program Name: QDBSTMGR<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The List Requested Statistics Collections (QDBSTLRS,
|
||
|
|
QdbstListRequestedStatistics) API lists details for not yet completed,
|
||
|
|
or not successfully completed statistics
|
||
|
|
collection requests, requested by a call to the
|
||
|
|
<a href= "qdbstrequeststatistics.htm">Request statistics collections
|
||
|
|
(OPM, QDBSTRS; ILE QdbstRequestStatistics) API</a>,
|
||
|
|
the <a href="qdbstupdatestatistics.htm">Update Statistics
|
||
|
|
Collection (QDBSTUS, QdbstUpdateStatistics) API</a>,
|
||
|
|
or automatically by the system.
|
||
|
|
The generated list replaces any existing list in the user space.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Section overview</h3>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#AuthAndLocks">Authorities and Locks</a></li>
|
||
|
|
<li><a href="#ReqParmGroup">Required Parameter Group</a></li>
|
||
|
|
|
||
|
|
<li><a href="#STIP0100Format">STIP0100 Input Format</a></li>
|
||
|
|
<li><a href="#VALIDKEYS">Valid Keys - Request output</a></li>
|
||
|
|
|
||
|
|
<li><a href="#GeneratedListFormat">Format of the Generated List</a></li>
|
||
|
|
|
||
|
|
<li><a href="#InputParmSection">Input parameter section</a></li>
|
||
|
|
<li><a href="#HeaderSection">Header section</a></li>
|
||
|
|
<li><a href="#ListDataSection">List data section</a></li>
|
||
|
|
|
||
|
|
<li><a href="#FieldDescriptions">Field Descriptions</a></li>
|
||
|
|
<li><a href="#ErrorMsgs">Error Messages</a></li>
|
||
|
|
<li><a href="#RelInfo">Related Information</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="AuthAndLocks">Authorities and Locks</a></h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>User Space Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*CHANGE</dd>
|
||
|
|
|
||
|
|
<dt><em>User Space Library Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*EXECUTE</dd>
|
||
|
|
|
||
|
|
<dt><em>User Space Lock</em></dt>
|
||
|
|
|
||
|
|
<dd>*EXCLRD</dd>
|
||
|
|
|
||
|
|
<dt><em>ASP Device Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*EXECUTE</dd>
|
||
|
|
|
||
|
|
<dt><em>File Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*OBJOPR</dd>
|
||
|
|
|
||
|
|
<dt><em>File Library Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*EXECUTE</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="ReqParmGroup">Required Parameter Group</a></h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Qualified user space name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(20)
|
||
|
|
|
||
|
|
<p>The user space that is to receive the generated list and the library in
|
||
|
|
which it is located. The first 10 characters contain the user space name, and
|
||
|
|
the second 10 characters contain the library name. You can use these special
|
||
|
|
values for the library name:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
||
|
|
<td align="left" valign="top">The job's current library or QGPL if the current
|
||
|
|
library is not set.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
||
|
|
<td align="left" valign="top">The library list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*USRLIBL</em></td>
|
||
|
|
<td align="left" valign="top">Libraries listed in the user portion of the
|
||
|
|
library list.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format of output</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the statistics collections list to be returned. If Format
|
||
|
|
STOP0100 is specified, the fields that were selected by the caller are returned
|
||
|
|
for each statistics collection request in the list. Possible format names
|
||
|
|
are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>STOP0100</em></td>
|
||
|
|
<td align="left" valign="top">Statistics collection requests list with keyed
|
||
|
|
return fields.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>Refer to <a href="#GeneratedListFormat">Format of the generated list</a> and
|
||
|
|
<a href="#STOP0100Format">STOP0100 Output Format</a> for more information.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Input data</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The buffer containing the input parameters according to the format of input
|
||
|
|
data parameter. The buffer content has to start at a 4-byte boundary.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of input data</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the input data buffer provided.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format of input data</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the input data. Possible values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>STIP0100</em></td>
|
||
|
|
<td align="left" valign="top">List Requested Statistics Collections input
|
||
|
|
parameters.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>Refer to <a href="#STIP0100Format">STIP0100 Input Format</a> for more
|
||
|
|
information.</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>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="STIP0100Format">STIP0100 Format</a></h4>
|
||
|
|
|
||
|
|
<p>The following table shows the input parameters for this API. See <a href=
|
||
|
|
"#FieldDescriptions">Field Descriptions</a> for details of the fields
|
||
|
|
listed.</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%">List filter option</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">CHAR(48)</td>
|
||
|
|
<td align="left" valign="top">Continuation handle</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">Offset to fields to return</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">Number of fields to return</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">60</td>
|
||
|
|
<td align="center" valign="top">3C</td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top"> </td>
|
||
|
|
<td align="center" valign="top"> </td>
|
||
|
|
<td align="left" valign="top">Array(*) of BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Keys of fields to return</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top"> </td>
|
||
|
|
<td align="center" valign="top"> </td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="VALIDKEYS">Valid Keys - Request output</a></h4>
|
||
|
|
|
||
|
|
<p>The keys listed below are used to determine in the
|
||
|
|
<a href="#STIP0100Format">STIP0100 Input Format</a>
|
||
|
|
what will be returned per
|
||
|
|
list entry in the <a href="#STOP0100Format">List Data Section - STOP0100 Output Format</a>.
|
||
|
|
Each key can only be specified once.
|
||
|
|
See <a href="#FieldDescriptions">Field Descriptions</a> for details of the
|
||
|
|
fields listed.</p>
|
||
|
|
|
||
|
|
<p>Each list entry returned in the output format describes a single request
|
||
|
|
and can be thought of as two groups of related keys:</p>
|
||
|
|
|
||
|
|
<p><em>Group 1</em>: The following keys describe information at
|
||
|
|
request level and are repeated in list entries describing
|
||
|
|
the single statistics collections within a request:</p>
|
||
|
|
|
||
|
|
<table border>
|
||
|
|
<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%">1</td>
|
||
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top" width="65%">ASP device name used</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">File name used</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">File library name used</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">File member name used</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</td>
|
||
|
|
<td align="left" valign="top">CHAR(16)</td>
|
||
|
|
<td align="left" valign="top">Internal request ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">34</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Name of requesting user profile</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">35</td>
|
||
|
|
<td align="left" valign="top">CHAR(26)</td>
|
||
|
|
<td align="left" valign="top">Time stamp of request</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">36</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Request status</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">37</td>
|
||
|
|
<td align="left" valign="top">CHAR(26)</td>
|
||
|
|
<td align="left" valign="top">Time stamp</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">38</td>
|
||
|
|
<td align="left" valign="top">CHAR(26)</td>
|
||
|
|
<td align="left" valign="top">Qualified job name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">39</td>
|
||
|
|
<td align="left" valign="top">CHAR(8)</td>
|
||
|
|
<td align="left" valign="top">Thread ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">40</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Progress percentage</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Estimated time</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">42</td>
|
||
|
|
<td align="left" valign="top">CHAR(7)</td>
|
||
|
|
<td align="left" valign="top">Message ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">49</td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Message Data</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">50</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Message File Library</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">51</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Message File</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">43</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Total number of statistics collections for
|
||
|
|
internal request ID</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><em>Group 2</em>: The following keys describe information at statistics collection
|
||
|
|
level for a request:</p>
|
||
|
|
|
||
|
|
<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%">44</td>
|
||
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top" width="65%">Running number of statistics
|
||
|
|
collection for internal request ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">46</td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Statistics collection name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">18</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Aging mode</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">28</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of columns</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">29</td>
|
||
|
|
<td align="left" valign="top">Array(*) of CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Column names</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">30</td>
|
||
|
|
<td align="left" valign="top">Array(*) of CHAR(20)</td>
|
||
|
|
<td align="left" valign="top">Qualified translation table names</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="GeneratedListFormat">Format of the Generated List</a></h3>
|
||
|
|
|
||
|
|
<p>The statistics collections list consists of:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>A user area</li>
|
||
|
|
|
||
|
|
<li>A generic header</li>
|
||
|
|
|
||
|
|
<li><a href="#InputParmSection">An input parameter section</a></li>
|
||
|
|
|
||
|
|
<li><a href="#HeaderSection">A header section</a></li>
|
||
|
|
|
||
|
|
<li><a href="#ListDataSection">A list data section</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>The user area and generic header are described in <a href="../apiref/usf.htm">User
|
||
|
|
space format for list APIs</a>. The remaining items are described in the
|
||
|
|
following sections.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="InputParmSection">Input Parameter Section</a></h4>
|
||
|
|
|
||
|
|
<p>The following information is returned in the input parameter section. For
|
||
|
|
detailed descriptions of the fields in this table, see <a href=
|
||
|
|
"#FieldDescriptions">Field Descriptions</a>.</p>
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom">Dec</th>
|
||
|
|
<th align="center" valign="bottom">Hex</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top" width="60%">User space name specified</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 space library name specified</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">20</td>
|
||
|
|
<td align="center" valign="top">14</td>
|
||
|
|
<td align="left" valign="top">CHAR(8)</td>
|
||
|
|
<td align="left" valign="top">Format of output specified</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">28</td>
|
||
|
|
<td align="center" valign="top">1C</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of input data specified</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">32</td>
|
||
|
|
<td align="center" valign="top">20</td>
|
||
|
|
<td align="left" valign="top">CHAR(8)</td>
|
||
|
|
<td align="left" valign="top">Format of input data specified</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">40</td>
|
||
|
|
<td align="center" valign="top">28</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">List filter option specified</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">44</td>
|
||
|
|
<td align="center" valign="top">2C</td>
|
||
|
|
<td align="left" valign="top">CHAR(48)</td>
|
||
|
|
<td align="left" valign="top">Continuation handle specified</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">92</td>
|
||
|
|
<td align="center" valign="top">5C</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Offset to fields to return specified</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">96</td>
|
||
|
|
<td align="center" valign="top">60</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of fields to return specified</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">100</td>
|
||
|
|
<td align="center" valign="top">64</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">
|
||
|
|
Displacement to specified fields to
|
||
|
|
return</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">104</td>
|
||
|
|
<td align="center" valign="top">68</td>
|
||
|
|
<td align="left" valign="top">Array(*) of BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Keys of fields to return specified</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="HeaderSection">Header Section</a></h4>
|
||
|
|
|
||
|
|
<p>For detailed descriptions of the fields in this table, see <a href=
|
||
|
|
"#FieldDescriptions">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(48)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Continuation handle</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">48</td>
|
||
|
|
<td align="center" valign="top" width="10%">30</td>
|
||
|
|
<td align="left" valign="top" width="20%"> </td>
|
||
|
|
<td align="left" valign="top" width="60%"> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4><a name="ListDataSection"></a>
|
||
|
|
<a name="STOP0100Format">List Data Section - STOP0100 Output Format</a></h4>
|
||
|
|
|
||
|
|
<p>The following information is returned in the list data section per
|
||
|
|
statistics collection list entry for Format STOP0100. The fields are returned
|
||
|
|
in the order requested. See <a href="#FieldDescriptions">Field Descriptions</a>
|
||
|
|
for details of the fields listed.</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 list entry</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 key fields returned</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" rowspan="5" 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 identifier</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 (padding to the next 4-byte
|
||
|
|
boundary)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="FieldDescriptions">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>ASP device name used.</strong> The actual auxiliary storage pool
|
||
|
|
device name used, after possible resolution of special values.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> If the API caller does not have the documented ASP
|
||
|
|
Device Authority for the ASP device, the ASP device name returned will be set
|
||
|
|
to all blanks.</p>
|
||
|
|
|
||
|
|
<p><strong>Aging mode.</strong> Whether the system is allowed to age or remove
|
||
|
|
the statistics collection. The possible values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*SYS</em></td>
|
||
|
|
<td align="left" valign="top">Refresh or removal of the resulting statistics
|
||
|
|
collections will be performed automatically by the system.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*USER</em></td>
|
||
|
|
<td align="left" valign="top">Refresh or removal will only occur when a user
|
||
|
|
requests it.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Column names.</strong> The array of names of the columns
|
||
|
|
within the statistics collection, in the same order as at request time. Each
|
||
|
|
array elements also corresponds to the array element at the same position in
|
||
|
|
the Qualified translation table names field. The array dimension is given by
|
||
|
|
the Number of columns field.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> If the API caller does not have the documented
|
||
|
|
<em>ASP Device Authority</em> , <em>File Authority</em>, and <em>File Library Authority</em> for
|
||
|
|
the file containing these specific columns, the column names
|
||
|
|
returned will be set to all blanks.</p>
|
||
|
|
|
||
|
|
<p><strong>Continuation handle (input section).</strong> The handle
|
||
|
|
used to continue from a previous call to this API that resulted in partially
|
||
|
|
complete information. You can determine if a previous call resulted in
|
||
|
|
partially complete information by checking the Information Status variable in
|
||
|
|
the generic user space header following the API call.</p>
|
||
|
|
|
||
|
|
<p>If the API is not attempting to continue from a previous call, this
|
||
|
|
parameter must be set to blanks. Otherwise, a valid continuation value must be
|
||
|
|
supplied. The value may be obtained from the list header section of the user
|
||
|
|
space used in the previous call. When continuing, the first entry in the
|
||
|
|
returned list is the entry that immediately follows the last entry returned in
|
||
|
|
the previous call.</p>
|
||
|
|
|
||
|
|
<p><strong>Continuation handle (header section).</strong> A continuation point
|
||
|
|
for the API. This value is set based on the contents of the Information Status
|
||
|
|
variable in the generic header for the user space. The following situations can
|
||
|
|
occur:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" nowrap><em>Information status-C</em></td>
|
||
|
|
<td align="left" valign="top">The information returned in the user space is
|
||
|
|
valid and complete. No continuation is necessary and the continuation handle is
|
||
|
|
set to blanks.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>Information status-P</em></td>
|
||
|
|
<td align="left" valign="top">The information returned in the user space is
|
||
|
|
valid but incomplete. The user may call the API again, starting where the last
|
||
|
|
call left off. The continuation handle contains a value which may be supplied
|
||
|
|
as an input parameter in later calls.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>Information status-I</em></td>
|
||
|
|
<td align="left" valign="top">The information returned in the user space is not
|
||
|
|
valid and incomplete. The content of the continuation handle is
|
||
|
|
unpredictable.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Data.</strong> The data returned for the key identifier.</p>
|
||
|
|
|
||
|
|
<p><strong>Displacement to specified fields to return.</strong> The
|
||
|
|
displacement to the start of the array of specified fields to return.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> This is not the offset specified on input, but the
|
||
|
|
displacement within the input parameter section. See <a href=
|
||
|
|
"#OffsetToFieldsSpecified">Offset to fields to return specified</a>
|
||
|
|
instead.</p>
|
||
|
|
|
||
|
|
<p><strong>Estimated time.</strong> The estimated time in seconds to collect
|
||
|
|
the statistics for this request. This will be zero for all request statuses but
|
||
|
|
<em>'0' (pending)</em> and <em>'1' (active)</em>.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> For request status <em>'1' (active)</em>, the
|
||
|
|
estimate is for the complete request, not for the remaining work to be done.
|
||
|
|
The also returned progress percentage can be used to calculate the estimated
|
||
|
|
time left before the request is complete.</p>
|
||
|
|
|
||
|
|
<p><strong>File library name used.</strong> The actual file library name used,
|
||
|
|
after possible resolution of special values.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> If the API caller does not have the documented <em>
|
||
|
|
ASP Device Authority</em> and <em>File Library Authority</em> for this specific
|
||
|
|
library, the library name returned will be set to all blanks.</p>
|
||
|
|
|
||
|
|
<p><strong>File member name used.</strong> The actual file member name used,
|
||
|
|
after possible resolution of special values.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> If the API caller does not have the documented ASP
|
||
|
|
Device Authority, File Authority, and File Library Authority for the file
|
||
|
|
containing this specific member, the file member name returned will be set to
|
||
|
|
all blanks.</p>
|
||
|
|
|
||
|
|
<p><strong>File name used.</strong> The actual file name used.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> If the API caller does not have the documented <em>
|
||
|
|
ASP Device Authority</em>, <em>File Authority</em>, and <em>File Library
|
||
|
|
Authority</em> for this specific file, the file name returned will be set to
|
||
|
|
all blanks.</p>
|
||
|
|
|
||
|
|
<p><strong>Internal request ID.</strong> Uniquely identifies a requested
|
||
|
|
statistics collections. See the <a href="qdbstrequeststatistics.htm">Request
|
||
|
|
statistics collections (OPM, QDBSTRS; ILE QdbstRequestStatistics) API</a>.</p>
|
||
|
|
|
||
|
|
<p><strong>Key identifier.</strong> The field returned. For a list of valid
|
||
|
|
keys see <a href="#VALIDKEYS">Valid Keys - Request output</a>.</p>
|
||
|
|
|
||
|
|
<p><strong>Keys of fields to return.</strong> The list of fields to return per
|
||
|
|
list entry. For a list of valid keys see <a href="#VALIDKEYS">Valid
|
||
|
|
Keys - Request output</a>.</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> Total number of bytes
|
||
|
|
returned for this field.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of list entry.</strong> Number of bytes returned for this
|
||
|
|
list entry.</p>
|
||
|
|
|
||
|
|
<p><strong>List filter option.</strong> The statistics collection requests to
|
||
|
|
return. The filter option is a bit field and can be computed by adding up
|
||
|
|
desired single filter values from the following list:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">List requests in <em>'0' (pending)</em>
|
||
|
|
status.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">List requests in <em>'1' (active)</em>
|
||
|
|
status.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>4</em></td>
|
||
|
|
<td align="left" valign="top">List requests in <em>'2' (error)</em>
|
||
|
|
status.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>For information on the request status, see the <a href="#RequestStatus">
|
||
|
|
Request Status</a> field.</p>
|
||
|
|
|
||
|
|
<p><strong>Message ID.</strong> For request status <em>'2' (error)</em> only: A
|
||
|
|
message ID describing the error.</p>
|
||
|
|
|
||
|
|
<p><strong>Message File.</strong> For request status <em>'2' (error)</em> only:
|
||
|
|
The message file for the <em>Message ID</em>.</p>
|
||
|
|
|
||
|
|
<p><strong>Message File Library.</strong> For request status <em>'2'
|
||
|
|
(error)</em> only: The library where the <em>Message File</em> is located.</p>
|
||
|
|
|
||
|
|
<p><strong>Message Data.</strong> For request status <em>'2' (error)</em> only:
|
||
|
|
The message field data for the <em>Message ID</em>.</p>
|
||
|
|
|
||
|
|
<p><strong>Name of requesting user profile.</strong> The name of user profile
|
||
|
|
that requested the statistics collection. The name will be *SYS for statistics
|
||
|
|
collections automatically requested by the system.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of columns.</strong> Number of columns within the single
|
||
|
|
statistics collection.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of fields to return.</strong> The number of fields to return
|
||
|
|
for each list entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of key fields returned.</strong> Number of fields actually
|
||
|
|
returned.</p>
|
||
|
|
|
||
|
|
<p><strong><a name="#OffsetToFieldsSpecified">Offset to fields to return
|
||
|
|
specified.</a></strong> Offset to fields to return as specified on the call of
|
||
|
|
the API.</p>
|
||
|
|
|
||
|
|
<p><strong>Progress percentage.</strong> For request status <em>'1'
|
||
|
|
(active)</em> only: The percentage of completion of the request. For all other
|
||
|
|
request statuses this will be zero.</p>
|
||
|
|
|
||
|
|
<p><strong>Qualified job name.</strong> Depending on the request status, the
|
||
|
|
following values are valid:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>'0' (pending)</em></td>
|
||
|
|
<td align="left" valign="top">The job that submitted the request.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>'1' (active)</em></td>
|
||
|
|
<td align="left" valign="top">The job processing the request.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>'2' (error)</em></td>
|
||
|
|
<td align="left" valign="top">The job that did process the request.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>The qualified job name has three parts:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>Job name</em></td>
|
||
|
|
<td align="left" valign="top">Char(10).</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>User name</em></td>
|
||
|
|
<td align="left" valign="top">Char(10).</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>Job number</em></td>
|
||
|
|
<td align="left" valign="top">Char(6).</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Qualified translation table names.</strong> The array of names of
|
||
|
|
the translation tables that were specified, when the statistics collection was
|
||
|
|
requested, in the same order as requested. Each array elements corresponds to
|
||
|
|
the array element at the same position in the Column names field. The first 10
|
||
|
|
characters contain the translation table name, and the second 10 characters
|
||
|
|
contain the name of the library where the table is located. The array dimension
|
||
|
|
is given by the Number of columns field.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> For system initiated requests, the translation table
|
||
|
|
name and the library can be set to the following special value:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*UNKNOWN</em></td>
|
||
|
|
<td align="left" valign="top">The information is not available in a suitable
|
||
|
|
form.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong><a name="RequestStatus">Request status.</a></strong> The current
|
||
|
|
status of the requested statistics collection. 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">Pending. Request is scheduled for later
|
||
|
|
processing.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
||
|
|
<td align="left" valign="top">Active. Request is currently being
|
||
|
|
processed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>'2'</em></td>
|
||
|
|
<td align="left" valign="top">Error. Request processing did end in error and no
|
||
|
|
statistics data was stored.
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> Only the most recently-ended requests are listed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> Reserved for future use. If this field is input,
|
||
|
|
the field must be set to hexadecimal zeros.</p>
|
||
|
|
|
||
|
|
<p><strong>Reserved (in STOP0100 output format).</strong> Structure padding to
|
||
|
|
guarantee alignment to the next 4-byte boundary.</p>
|
||
|
|
|
||
|
|
<p><strong>Running number of statistics collections for internal request
|
||
|
|
ID.</strong> Current index of the statistics collection definition for this
|
||
|
|
request. The statistics collection definitions will be returned in the same
|
||
|
|
order as requested.</p>
|
||
|
|
|
||
|
|
<p><strong>Statistics collection name.</strong> A name unique among all
|
||
|
|
statistics collections for the file member.</p>
|
||
|
|
|
||
|
|
<p><strong>Thread ID.</strong> For request status <em>'1' (active)</em> only:
|
||
|
|
The thread that is currently processing the request.</p>
|
||
|
|
|
||
|
|
<p><strong>Time stamp.</strong> Depending on the request status, this time stamp
|
||
|
|
shows:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>'0' (pending)</em></td>
|
||
|
|
<td align="left" valign="top">The time the request was made (same as time stamp
|
||
|
|
of request).</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>'1' (active)</em></td>
|
||
|
|
<td align="left" valign="top">The time processing started.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>'2' (error)</em></td>
|
||
|
|
<td align="left" valign="top">The time the request ended in error.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Time stamp of request.</strong> The time stamp showing when the
|
||
|
|
statistics collection was requested.</p>
|
||
|
|
|
||
|
|
<p><strong>Total number of statistics collections for internal request
|
||
|
|
ID.</strong> The number of statistics collection definitions for this request,
|
||
|
|
identified by the internal request ID.</p>
|
||
|
|
|
||
|
|
<p><strong>User space name specified.</strong> The user space name as specified
|
||
|
|
on the call of the API.</p>
|
||
|
|
|
||
|
|
<p><strong>User space library name specified.</strong> The user space library
|
||
|
|
name as specified on the call of the API.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="ErrorMsgs">Error Messages</a></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">CPF0623 E</td>
|
||
|
|
<td align="left" valign="top">Field &1 not found in record format &2.</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">CPF2105 E</td>
|
||
|
|
<td align="left" valign="top">Object &1 in &2 type *&3 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF2113 E</td>
|
||
|
|
<td align="left" valign="top">Cannot allocate library &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF2173 E</td>
|
||
|
|
<td align="left" valign="top">Value for ASPDEV not valid with special value for library.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF218C E</td>
|
||
|
|
<td align="left" valign="top">&1 not a primary or secondary ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3141 E</td>
|
||
|
|
<td align="left" valign="top">Member &2 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF34C0 E</td>
|
||
|
|
<td align="left" valign="top">Value &1 for number of fields to return parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C07 E</td>
|
||
|
|
<td align="left" valign="top">Error occurred while retrieving information from object &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C1D E</td>
|
||
|
|
<td align="left" valign="top">Length specified in parameter &1 not valid.</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">CPF3C29 E</td>
|
||
|
|
<td align="left" valign="top">Object name &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C36 E</td>
|
||
|
|
<td align="left" valign="top">Number of parameters, &1, entered for this API was not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C39 E</td>
|
||
|
|
<td align="left" valign="top">Value for reserved field 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">CPF3C82 E</td>
|
||
|
|
<td align="left" valign="top">Key &1 not valid for API &2.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C89 E</td>
|
||
|
|
<td align="left" valign="top">Key &1 specified more than once.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3CE2 E</td>
|
||
|
|
<td align="left" valign="top">Continuation handle not valid.</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">CPF4268 E</td>
|
||
|
|
<td align="left" valign="top">Object &1 in &2 type *&3 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9802 E</td>
|
||
|
|
<td align="left" valign="top">Not authorized to object &2 in &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9803 E</td>
|
||
|
|
<td align="left" valign="top">Cannot allocate object &2 in library &3.</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">CPF980B E</td>
|
||
|
|
<td align="left" valign="top">Object &1 in library &2 not available.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9810 E</td>
|
||
|
|
<td align="left" valign="top">Library &1 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9812 E</td>
|
||
|
|
<td align="left" valign="top">File &1 in library &2 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9814 E</td>
|
||
|
|
<td align="left" valign="top">Device &1 not found.</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">CPF9822 E</td>
|
||
|
|
<td align="left" valign="top">Not authorized to file &1 in library &2.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9825 E</td>
|
||
|
|
<td align="left" valign="top">Not authorized to device &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9826 E</td>
|
||
|
|
<td align="left" valign="top">Cannot allocate file &2.</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">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">CPFB401 E</td>
|
||
|
|
<td align="left" valign="top">API &3 failed with reason code &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFB8ED E</td>
|
||
|
|
<td align="left" valign="top">Device description &1 not correct for operation.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="RelInfo">Related Information</a></h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>the <<strong>qdbst.h</strong>> include file in library QSYSINC, for
|
||
|
|
API-related structure declarations and special value declarations.<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>the <<strong>qdbstmgr.h</strong>> include file in library QSYSINC,
|
||
|
|
for the QdbstListRequestedStatistics API prototype.<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>the <<strong>qdbstlrs.h</strong>> include file in library QSYSINC,
|
||
|
|
for the QDBSTLRS API prototype.<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="qdbstcancelrequestedstatistics.htm">Cancel Requested Statistics
|
||
|
|
Collections</a> (QDBSTCRS, QdbstCancelRequestedStatistics) API<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="qdbstdeletestatistics.htm">Delete Statistics Collections</a>
|
||
|
|
(QDBSTDS, QdbstDeleteStatistics) API<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="qdbstlistdetailstatistics.htm">List Statistics Collection
|
||
|
|
Details</a> (QDBSTLDS, QdbstListDetailStatistics) API<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="qdbstliststatistics.htm">List Statistics Collections</a> (QDBSTLS,
|
||
|
|
QdbstListStatistics) API<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="qdbstrequeststatistics.htm">Request Statistics Collections</a>
|
||
|
|
(QDBSTRS, QdbstRequestStatistics) API<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="qdbstupdatestatistics.htm">Update Statistics Collections</a>
|
||
|
|
(QDBSTUS, QdbstUpdateStatistics) API</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R2
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"file1.htm">Database and File APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|