976 lines
23 KiB
HTML
976 lines
23 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 Record Formats (QUSLRCD) 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 -->
|
|
<!-- File SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
|
<!--File Edited March 2001 -->
|
|
<!-- This file has undergone html cleanup on 9/24/01 by JET -->
|
|
<!--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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>List Record Formats (QUSLRCD) 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 name</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">Qualified file name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(20)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Override processing</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Optional Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">5</td>
|
|
<td align="left" valign="top" width="50%">Error code</td>
|
|
<td align="left" valign="top" width="20%">I/O</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Service Program Name: QUSLRCD<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The List Record Formats (QUSLRCD) API generates a list of record format
|
|
information contained within the specified file and places the list in a
|
|
specified user space. The created list replaces any existing information in the
|
|
user space.</p>
|
|
|
|
<p>You can use the QUSLRCD API with database file types, such as *PF, *LF, and
|
|
*DDMF, and device file types, such as *DSPF, *TAPF, *DKTF, *PRTF, *SAVF, and
|
|
*ICFF.</p>
|
|
|
|
<br>
|
|
<h3>Authorities and Locks</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>File Library Authority</em></dt>
|
|
|
|
<dd>*USE</dd>
|
|
|
|
<dt><em>File Authority</em></dt>
|
|
|
|
<dd>*OBJOPR</dd>
|
|
|
|
<dt><em>User Space Lock</em></dt>
|
|
|
|
<dd>*EXCLRD</dd>
|
|
|
|
<dt><em>File Lock</em></dt>
|
|
|
|
<dd>*SHRRD</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Qualified user space name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The name of 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 width="100%">
|
|
<tr>
|
|
<td width="15%" valign="top"><em>*CURLIB</em></td>
|
|
<td width="85%" valign="top">The job's current library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*LIBL</em></td>
|
|
<td valign="top">The library list</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"></td>
|
|
<td valign="top"></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the information returned. The possible format names are:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="15%" valign="top"><em>RCDL0100</em></td>
|
|
<td width="85%" valign="top">Record format name only.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>RCDL0200</em></td>
|
|
<td valign="top">Record format name and additional information. This format
|
|
requires more system paging and takes longer to produce than the RCDL0100
|
|
format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>RCDL0300</em></td>
|
|
<td valign="top">Record format name and device file information. This format
|
|
requires more system paging and takes longer to produce than the RCDL0100
|
|
format. This format is only applicable to device file types.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p>For more information, see <a href="#HDRRCDLLS1">RCDL0100 List Data
|
|
Section</a>, <a href="#HDRRCDLLS2">RCDL0200 List Data Section</a> or <a href=
|
|
"#HDRRCDLLS3">RCDL0300 List Data Section</a></p>
|
|
</dd>
|
|
|
|
<dt><strong>Qualified file name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The name of the file whose record format names are placed in the list, and
|
|
the library in which it is located. The first 10 characters contain the file
|
|
name, and the second 10 characters contain the library name. You can use these
|
|
special values for the library name:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="15%" valign="top"><em>*CURLIB</em></td>
|
|
<td width="85%" valign="top">The job's current library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*LIBL</em></td>
|
|
<td valign="top">The library list</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Override processing</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>Whether overrides are to be processed. The possible values are:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="5%" valign="top"><em>0</em></td>
|
|
<td width="95%" valign="top">No override processing</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1</em></td>
|
|
<td valign="top">Override processing</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Optional Parameter</h3>
|
|
|
|
<dl>
|
|
<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>. If this
|
|
parameter is omitted, diagnostic and escape messages are issued to the
|
|
application.</p>
|
|
</dd>
|
|
</dl>
|
|
<br>
|
|
<h3><a name="HDRRCDLIST">Format of the Generated List</a></h3>
|
|
|
|
<p>The record format list consists of:</p>
|
|
|
|
<ul>
|
|
<li>A user area</li>
|
|
|
|
<li>A generic header</li>
|
|
|
|
<li>An input parameter section</li>
|
|
|
|
<li>A header section</li>
|
|
|
|
<li>A list data section</li>
|
|
</ul>
|
|
|
|
<p>For details about the user area and generic header, see <a href="../apiref/usf.htm">
|
|
User Space Format for List APIs</a>. For details about the other items, see the
|
|
following sections. For descriptions of each field, see <a href="#HDRRCDD">
|
|
Field Descriptions</a>.</p>
|
|
|
|
<p>When you retrieve list entry information from a user space, you must use the
|
|
entry size returned in the generic header as a displacement to the next list
|
|
entry. The size of each entry may be padded at the end. If you do not use the
|
|
entry size, the result may not be valid. For examples of how to process lists,
|
|
see <a href="../apiref/apiexmp.htm">API
|
|
examples</a>.</p>
|
|
|
|
<br>
|
|
<h3><a name="HDRRCDLIP1">Input Parameter Section</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%">User space 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 space library name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Format name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">38</td>
|
|
<td align="center" valign="top">26</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File library name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Override processing</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<h3><a name="HDRRCDLHD1">Header Section</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%">File name used</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">File library name used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">File type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="center" valign="top">1E</td>
|
|
<td align="left" valign="top">CHAR(50)</td>
|
|
<td align="left" valign="top">File text description</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">File text description CCSID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="left" valign="top">CHAR (13)</td>
|
|
<td align="left" valign="top">File creation date</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRRCDLLS1">RCDL0100 List Data Section</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%">Record format name</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRRCDLLS2">RCDL0200 List Data Section</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%">Record format name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(13)</td>
|
|
<td align="left" valign="top">Record format ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">23</td>
|
|
<td align="center" valign="top">17</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Record length</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">Number of fields</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">CHAR(50)</td>
|
|
<td align="left" valign="top">Record text description</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">82</td>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Record text description CCSID</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRRCDLLS3">RCDL0300 List Data Section</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%">Record format name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Lowest response indicator</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">Buffer size</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">CHAR(20)</td>
|
|
<td align="left" valign="top">Record format type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Starting line number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">37</td>
|
|
<td align="center" valign="top">25</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Separate indicator area present</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRRCDD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Buffer size.</strong> The user buffer size.</p>
|
|
|
|
<p><strong>Record text description CCSID.</strong></p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="10%" valign="top"><em>0</em></td>
|
|
<td width="90%" valign="top">There is no record text description.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1-65,535</em></td>
|
|
<td valign="top">The CCSID for the record text description.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>File creation date.</strong> The date of the file in the format
|
|
CYYMMDDHHMMSS as follows:</p>
|
|
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="15%" valign="top"><em>C</em></td>
|
|
<td width="85%" valign="top">Century, where 0 indicates years 19<em>xx</em> and
|
|
1 indicates years 20<em>xx</em>.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>YY</em></td>
|
|
<td valign="top">Year</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>MM</em></td>
|
|
<td valign="top">Month</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>DD</em></td>
|
|
<td valign="top">Day</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>HH</em></td>
|
|
<td valign="top">Hour</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>MM</em></td>
|
|
<td valign="top">Minute</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>SS</em></td>
|
|
<td valign="top">Second</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>File library name specified.</strong> The name of the file library
|
|
specified in the call to the API.</p>
|
|
|
|
<p><strong>File library name used.</strong> The name of the library that
|
|
contained the file. If the library requested was *LIBL or *CURLIB, this field
|
|
contains the name of the library where the system found the file.</p>
|
|
|
|
<p><strong>File name specified.</strong> The name of the file specified in the
|
|
call to the API.</p>
|
|
|
|
<p><strong>File name used.</strong> The name of the file whose record formats
|
|
are listed. If override processing was requested, this is the actual file.</p>
|
|
|
|
<p><strong>File text description.</strong> The text description of the
|
|
file.</p>
|
|
|
|
<p><strong>File text description CCSID.</strong></p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="10%" valign="top"><em>0</em></td>
|
|
<td width="90%" valign="top">There is no file text description.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1-65,535</em></td>
|
|
<td valign="top">The CCSID for the file text description.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>File type.</strong> The type of file found:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="15%" valign="top"><em>BSCF</em></td>
|
|
<td width="85%" valign="top">Binary synchronous communications (BSC) file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>CMNF</em></td>
|
|
<td valign="top">Communications file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>DSPF</em></td>
|
|
<td valign="top">Display file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>DDMF</em></td>
|
|
<td valign="top">Distributed data management file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>DKTF</em></td>
|
|
<td valign="top">Diskette file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>ICFF</em></td>
|
|
<td valign="top">Intersystem communications function file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>LF</em></td>
|
|
<td valign="top">Logical file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>MXDF</em></td>
|
|
<td valign="top">Mixed file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>PF</em></td>
|
|
<td valign="top">Physical file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>PRTF</em></td>
|
|
<td valign="top">Printer file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>SAVF</em></td>
|
|
<td valign="top">Save file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>TAPF</em></td>
|
|
<td valign="top">Tape file</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>Lowest response indicator.</strong> The lowest response indicator in
|
|
the file. The possible values are:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="15%" valign="top"><em>00</em></td>
|
|
<td width="85%" valign="top">No response indicators in the file or response
|
|
indicators are not applicable</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>01-99</em></td>
|
|
<td valign="top">Response indicator</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>Number of fields.</strong> The number of fields contained in this
|
|
record format. You can use the List Field Description (QUSLFLD) API to retrieve
|
|
field information about this record.</p>
|
|
|
|
<p><strong>Override processing.</strong> Whether overrides are to be processed.
|
|
The possible values are:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="5%" valign="top"><em>0</em></td>
|
|
<td width="95%" valign="top">No override processing</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1</em></td>
|
|
<td valign="top">Override processing</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>Record format name.</strong> The name of the format used to list
|
|
records. The possible values are:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="15%" valign="top"><em>RCDL0100</em></td>
|
|
<td width="85%" valign="top">Record format name only</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>RCDL0200</em></td>
|
|
<td valign="top">Record format name and additional information</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>RCDL0300</em></td>
|
|
<td valign="top">Record format name and device information</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>Record format name.</strong> The name of this record format.</p>
|
|
|
|
<p><strong>Record length.</strong> The length of this record format.</p>
|
|
|
|
<p><strong>Record text description.</strong> The text description of this
|
|
record format.</p>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>Record format type.</strong> The type of this record format. The
|
|
possible values are:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="15%" valign="top"><em>Normal</em></td>
|
|
<td width="85%" valign="top">Normal record</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>SFL</em></td>
|
|
<td valign="top">Subfile record</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>SFLMSGRCD</em></td>
|
|
<td valign="top">Subfile message record</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>SFLCTL</em></td>
|
|
<td valign="top">Subfile control record</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>USRDFN</em></td>
|
|
<td valign="top">User-defined record</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>WINDOW</em></td>
|
|
<td valign="top">Window record</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>Separate indicator area present.</strong> The existence of a
|
|
separate indicator area. The possible values are:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="5%" valign="top"><em>0</em></td>
|
|
<td width="95%" valign="top">No indicator area</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1</em></td>
|
|
<td valign="top">Indicator area</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>Starting line number.</strong> A starting line number was specified
|
|
for this record format. The possible values are:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td width="5%" valign="top"><em>0</em></td>
|
|
<td width="95%" valign="top">Starting line number is not specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1</em></td>
|
|
<td valign="top">Starting line number is specified.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>User space library name.</strong> The name of the library that
|
|
contains the user space that is to receive the generated list.</p>
|
|
|
|
<p><strong>User space name.</strong> The name of the user space that is to
|
|
receive the generated list.</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 width="15%" valign="top">CPF24B4 E</td>
|
|
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF2 E</td>
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C20 E</td>
|
|
<td valign="top">Error found by program &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C21 E</td>
|
|
<td valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C22 E</td>
|
|
<td valign="top">Cannot get information about file &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C25 E</td>
|
|
<td valign="top">Value &1 for file override parameter is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C36 E</td>
|
|
<td valign="top">Number of parameters, &1, entered for this API was not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C90 E</td>
|
|
<td valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF8100 E</td>
|
|
<td valign="top">All CPF81xx messages could be returned. xx is from 01 to
|
|
FF.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9800 E</td>
|
|
<td valign="top">All CPF98xx messages could be signaled. xx is from 01 to
|
|
FF.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9872 E</td>
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
|
Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V1R3
|
|
|
|
<hr>
|
|
<center>
|
|
<table 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>
|
|
</center>
|
|
|
|
<br>
|
|
</body>
|
|
</html>
|
|
|