970 lines
27 KiB
HTML
970 lines
27 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 Open Files (QDMLOPNF)</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 -->
|
||
|
|
<!-- File cleanup completed Feb 2002 by v2cdijab -->
|
||
|
|
<!-- Created by V2DCIJB on 23 Nov 1999 -->
|
||
|
|
<!-- 020801 JETAYLOR fix for reserved fields per Brian Bratager -->
|
||
|
|
<!-- 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 Open Files (QDMLOPNF)</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="20%">Output</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Length of receiver variable</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Format of receiver information</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">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">5</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">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>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The List Open Files (QDMLOPNF) API generates a list of *FILE objects that
|
||
|
|
are currently open in the job or that were opened by the thread that is
|
||
|
|
specified in the job identification information input parameter.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Job Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>This API must be called from within the job for which the information is
|
||
|
|
being retrieved, or the caller of the API must be running under a user profile
|
||
|
|
that is the same as the job user identity of the job for which the information
|
||
|
|
is being retrieved. Otherwise, the caller of the API must be running under a
|
||
|
|
user profile that has job control (*JOBCTL) special authority.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p>The <strong>job user identity</strong> is the name of the user profile by
|
||
|
|
which a job is known to other jobs. It is described in more detail in the
|
||
|
|
<a href="../rzaks/rzaks1.htm">Work Management</a> topic.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Receiver variable</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The receiver variable that is to receive the information requested. You can
|
||
|
|
specify the size of the area to be smaller than the format requested as long as
|
||
|
|
you specify the length of receiver variable parameter correctly. As a result,
|
||
|
|
the API returns only the amount of data specified in the length of receiver
|
||
|
|
variable.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the receiver variable provided. The length of receiver
|
||
|
|
variable parameter may be specified up to the size of the receiver variable
|
||
|
|
specified in the user program. If the length of receiver variable parameter
|
||
|
|
specified is larger than the allocated size of the receiver variable specified
|
||
|
|
in the user program, the results are not predictable. The minimum length is 8
|
||
|
|
bytes.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format of receiver information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the information returned in the receiver variable. The
|
||
|
|
possible format name is:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>OPNF0100</em></td>
|
||
|
|
<td align="left" valign="top">See <a href="#OPNF0100">Format OPNF0100</a> for
|
||
|
|
details on the list of files that this job or thread has open.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Job identification information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The information that is used to identify the job or thread for which the
|
||
|
|
list of open files is to be returned. See <a href="#JIDF0100">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="#JIDF0100">Format JIDF0100</a> for
|
||
|
|
details.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; CHAR(*)
|
||
|
|
|
||
|
|
<p>The structure in which to return error information. For the format of the
|
||
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error code parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="OPNF0100">Format OPNF0100</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(4)</td>
|
||
|
|
<td align="left" valign="top">Number of open files available</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">Offset to list of open files</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">Number of open files returned</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">Length of open file entry</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">24</td>
|
||
|
|
<td align="center" valign="top">18</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Job name used</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">34</td>
|
||
|
|
<td align="center" valign="top">22</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Job user name used</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">44</td>
|
||
|
|
<td align="center" valign="top">2C</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">50</td>
|
||
|
|
<td align="center" valign="top">32</td>
|
||
|
|
<td align="left" valign="top">CHAR(8)</td>
|
||
|
|
<td align="left" valign="top">Thread identifier used</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>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" colspan="2" rowspan="21">These fields repeat, in
|
||
|
|
the order listed, for the number of open files.</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">File name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">File library</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Member or device name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">File type</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Record format</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Activation group name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(8)</td>
|
||
|
|
<td align="left" valign="top">Thread identifier</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Open option</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(8)</td>
|
||
|
|
<td align="left" valign="top">Activation group number</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(8)</td>
|
||
|
|
<td align="left" valign="top">Write count</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(8)</td>
|
||
|
|
<td align="left" valign="top">Read count</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(8)</td>
|
||
|
|
<td align="left" valign="top">Write/read count</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(8)</td>
|
||
|
|
<td align="left" valign="top">Other I/O count</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(8)</td>
|
||
|
|
<td align="left" valign="top">Relative record number</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(8)</td>
|
||
|
|
<td align="left" valign="top">Number of shared opens</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">
|
||
|
|
BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Object auxiliary storage pool number</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Library auxiliary storage pool number</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Object auxiliary storage pool name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Library auxiliary storage pool name</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRLFLDD1">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Activation group name.</strong> The name of the activation group to
|
||
|
|
which an open file is scoped. This field can contain the following special
|
||
|
|
values:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*DFTACTGRP</em></td>
|
||
|
|
<td align="left" valign="top">The file is scoped to the default activation
|
||
|
|
group.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*JOB</em></td>
|
||
|
|
<td align="left" valign="top">The file is scoped to the job, not a specific
|
||
|
|
activation group.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*NEW</em></td>
|
||
|
|
<td align="left" valign="top">The file is scoped to a *NEW activation
|
||
|
|
group.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Activation group number.</strong> The number of the activation group
|
||
|
|
to which an open file is scoped. This field will contain zero for files scoped
|
||
|
|
to the job.</p>
|
||
|
|
|
||
|
|
<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>File library.</strong> The name of the library that contains the
|
||
|
|
open file. If the file is an inline data file, blanks are returned. For DDM
|
||
|
|
files, this is the library in which the DDM file is located.</p>
|
||
|
|
|
||
|
|
<p><strong>File name.</strong> The name of the file that is open. This field
|
||
|
|
will contain the value QINLINE for unnamed inline data files. For DDM files,
|
||
|
|
this is the name of the DDM file.</p>
|
||
|
|
|
||
|
|
<p><strong>File type.</strong> The type of file that is open.</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>BSCF</em></td>
|
||
|
|
<td align="left" valign="top">Binary Synchronous Communications (BSC) file</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>CMNF</em></td>
|
||
|
|
<td align="left" valign="top">Communications file</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>DDMF</em></td>
|
||
|
|
<td align="left" valign="top">Distributed Data Management file</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>DKTF</em></td>
|
||
|
|
<td align="left" valign="top">Diskette file (spooled and non-spooled)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>DSPF</em></td>
|
||
|
|
<td align="left" valign="top">Display file</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>ICFF</em></td>
|
||
|
|
<td align="left" valign="top">Intersystem Communications Function file</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>LF</em></td>
|
||
|
|
<td align="left" valign="top">Logical file</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>MXDF</em></td>
|
||
|
|
<td align="left" valign="top">Mixed file</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>PF</em></td>
|
||
|
|
<td align="left" valign="top">Physical file</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>PRTF</em></td>
|
||
|
|
<td align="left" valign="top">Printer file (spooled and non-spooled)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>SAVF</em></td>
|
||
|
|
<td align="left" valign="top">Save file</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>TAPF</em></td>
|
||
|
|
<td align="left" valign="top">Tape file</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*INLINE</em></td>
|
||
|
|
<td align="left" valign="top">Inline data file</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Job name used.</strong> The name of the job for which open files
|
||
|
|
were listed.</p>
|
||
|
|
|
||
|
|
<p><strong>Job number used.</strong> The number of the job for which open files
|
||
|
|
were listed.</p>
|
||
|
|
|
||
|
|
<p><strong>Job user name used.</strong> The user name of the job for which open
|
||
|
|
files were listed.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of open file entry.</strong> The length of each open file
|
||
|
|
entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Library auxilliary
|
||
|
|
storage pool name.</strong> The name of the auxilliary storage pool (ASP) in
|
||
|
|
which the library of the open file resides. This field can contain the
|
||
|
|
following special values:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*SYSBAS</em></td>
|
||
|
|
<td align="left" valign="top">The library resides in the system ASP or a basic
|
||
|
|
user ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*N</em></td>
|
||
|
|
<td align="left" valign="top">The ASP name could not be determined at this
|
||
|
|
time.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Library auxiliary storage pool number.</strong> The number of the
|
||
|
|
auxiliary storage pool (ASP) in which the library of the open file resides.
|
||
|
|
Possible values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">System ASP</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2-32</em></td>
|
||
|
|
<td align="left" valign="top">Basic user ASPs</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" nowrap><em>33-255</em></td>
|
||
|
|
<td align="left" valign="top">Independent ASPs</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Member or device name.</strong> If the file type is physical (PF) or
|
||
|
|
logical (LF), this is the name of the database member. If multiple member
|
||
|
|
processing is being performed, the value *ALL is returned. For device files
|
||
|
|
(BSCF, CMNF, DKTF, DSPF, ICFF, MXDF, PRTF, SAVF, or TAPF), this is the name of
|
||
|
|
the last program device used for an I/O operation. This field is blank for
|
||
|
|
device files when no I/O operation has been performed, and always for inline
|
||
|
|
data files. If the file is a spooled file, the value *SPOOL is returned. If the
|
||
|
|
file is a DDM file, blanks are returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of open files available.</strong> The number of open files
|
||
|
|
available to be returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of open files returned.</strong> The number of complete open
|
||
|
|
file entries that are returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of shared opens.</strong> The number of times the file was
|
||
|
|
opened for shared processing. This field will contain zero for open operations
|
||
|
|
that are not shared.</p>
|
||
|
|
|
||
|
|
<p><strong>Object auxilliary
|
||
|
|
storage pool name.</strong> The name of the auxilliary storage pool (ASP) in
|
||
|
|
which the open file resides. This field can contain the following special
|
||
|
|
values:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*SYSBAS</em></td>
|
||
|
|
<td align="left" valign="top">The object resides in the system ASP or a basic
|
||
|
|
user ASP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*N</em></td>
|
||
|
|
<td align="left" valign="top">The ASP name could not be determined at this
|
||
|
|
time.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Object auxiliary storage pool number.</strong> The number of the
|
||
|
|
auxiliary storage pool (ASP) in which the open file resides. Possible values
|
||
|
|
are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">System ASP</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2-32</em></td>
|
||
|
|
<td align="left" valign="top">Basic user ASPs</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" nowrap><em>33-255</em></td>
|
||
|
|
<td align="left" valign="top">Independent ASPs</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Offset to list of open files.</strong> The offset in bytes from the
|
||
|
|
beginning of the receiver variable to the first open file entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Open option.</strong> The type of open operation that is
|
||
|
|
performed:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">The file was opened for input operations
|
||
|
|
only.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The file was opened for output operations
|
||
|
|
only.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">The file was opened for all operations (input,
|
||
|
|
output, update, and delete).</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Other I/O count.</strong> Number of successful I/O operations of the
|
||
|
|
following types:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>update</li>
|
||
|
|
|
||
|
|
<li>delete</li>
|
||
|
|
|
||
|
|
<li>change end-of-data</li>
|
||
|
|
|
||
|
|
<li>force end-of-data</li>
|
||
|
|
|
||
|
|
<li>force end-of-volume</li>
|
||
|
|
|
||
|
|
<li>release record lock</li>
|
||
|
|
|
||
|
|
<li>acquire or release program device</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p><strong>Read count.</strong> Number of successful read operations. If record
|
||
|
|
blocking is not in effect for the file, this is the number of records. If
|
||
|
|
record blocking is in effect for the file, this is the number of record
|
||
|
|
blocks.</p>
|
||
|
|
|
||
|
|
<p><strong>Record format.</strong> The name of the last record format that was
|
||
|
|
used for an I/O operation to the file. If no record format name was used or no
|
||
|
|
I/O operations have been performed, this field is blank.</p>
|
||
|
|
|
||
|
|
<p><strong>Relative record number.</strong> Relative record number of the last
|
||
|
|
record referred to by an I/O or open operation for database files. Zero is
|
||
|
|
returned for nondatabase files and database files on which no I/O operations
|
||
|
|
have been performed.</p>
|
||
|
|
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
||
|
|
|
||
|
|
|
||
|
|
<p><strong>Thread identifier.</strong> An 8-byte thread handle assigned by the
|
||
|
|
system. It identifies the thread in which the file was opened.</p>
|
||
|
|
|
||
|
|
<p><strong>Thread identifier used.</strong> The identifier of the thread for
|
||
|
|
which open files were listed. A value of zero indicates open files were
|
||
|
|
returned for all threads within the job.</p>
|
||
|
|
|
||
|
|
<p><strong>Write count.</strong> The number of successful write operations. If
|
||
|
|
record blocking is not in effect for the file, this is the number of records.
|
||
|
|
If record blocking is in effect for the file, this is the number of record
|
||
|
|
blocks.</p>
|
||
|
|
|
||
|
|
<p><strong>Write/Read count.</strong> The number of successful write/read
|
||
|
|
operations.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="JIDF0100">Format JIDF0100</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%">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="HDRLFLDD">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 the 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 in which this program is running. 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
|
||
|
|
hexadecimal zeros.</p>
|
||
|
|
|
||
|
|
|
||
|
|
<p><strong>Thread identifier.</strong> The unique value used to identify the
|
||
|
|
thread within the job. If the thread indicator is not 0, this field must
|
||
|
|
contain hexadecimal zeroes.</p>
|
||
|
|
|
||
|
|
<p><strong>Thread indicator.</strong> The value that is used to specify the
|
||
|
|
thread within the job for which information is to be retrieved. The following
|
||
|
|
values are supported:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">The value in the thread identifier field should
|
||
|
|
be used to locate the thread.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Information should be retrieved for the thread in
|
||
|
|
which this program is running. The combination of the internal job identifier,
|
||
|
|
job name, job number, and user name fields also must identify the job
|
||
|
|
containing the current thread.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">Information should be retrieved for the initial
|
||
|
|
thread of the identified job.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>3</em></td>
|
||
|
|
<td align="left" valign="top">Information should be retrieved for all threads
|
||
|
|
within the specified job.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>User name.</strong> A specific user profile name, or blanks when the
|
||
|
|
job name specified is a special value.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table 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">CPF136A E</td>
|
||
|
|
<td align="left" valign="top">Job not active.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
||
|
|
<td align="left" valign="top">Severe error while addressing parameter
|
||
|
|
list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">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">CPF3C24 E</td>
|
||
|
|
<td align="left" valign="top">Length of the receiver variable is not
|
||
|
|
valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C3B E</td>
|
||
|
|
<td align="left" valign="top">Value for parameter 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">CPF3C55 E</td>
|
||
|
|
<td align="left" valign="top">Job does not exist.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C57 E</td>
|
||
|
|
<td align="left" valign="top">Not authorized to retrieve job information.</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">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">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">CPF9999 E</td>
|
||
|
|
<td align="left" valign="top">Function check.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R1
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_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>
|
||
|
|
|