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

2217 lines
61 KiB
HTML
Raw Blame History

<!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 Fields (QUSLFLD) 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. -->
<!-- File SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>List Fields (QUSLFLD) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="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">Record format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</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>
&nbsp;&nbsp;Optional Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">6</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The List Fields (QUSLFLD) API generates a list of fields within a specified
file record format name. The list of fields is placed in a specified user
space. The generated list replaces any existing information in the user space.
You can use the QUSLFLD API only with database file types, such as *PF, *LF,
and *DDMF, and device file types, such as *ICFF and *PRTF.</p>
<p>You can use the QUSLFLD API to:</p>
<ul>
<li>Generate a list of field format names.</li>
<li>Gather additional information about specific field formats.</li>
<li>Create a product similar to the Structured Query Language (SQL) using the
Open Query File (OPNQRYF) command.</li>
<li>Create applications similar to the data file utility (DFU).</li>
<li>Create a compiler supporting externally described data.</li>
<li>Create applications that use data defined to the system.</li>
</ul>
<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 created 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</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the information returned. You must use the following format
name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>FLDL0100</em></td>
<td align="left" valign="top">Field information</td>
</tr>
<tr>
<td align="left" valign="top"><em>FLDL0200</em></td>
<td align="left" valign="top">Field and default value information</td>
</tr>
<tr>
<td align="left" valign="top"><em>FLDL0300</em></td>
<td align="left" valign="top">Field, alternative field name, and default value
information</td>
</tr>
</table>
<p>For more information, see <a href="#HDRFLDLIST">Format of the Generated
List</a>.</p>
</dd>
<dt><strong>Qualified file name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The file whose member names are to be 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 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</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Record format name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The record format name whose fields are to be returned.</p>
</dd>
<dt><strong>Override processing</strong></dt>
<dd>INPUT; CHAR(1)
<p>Whether overrides are to be processed. 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">No override processing</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Override processing</td>
</tr>
</table>
</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="HDRFLDLIST">Format of the Generated List</a></h3>
<p>The field 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><em></em>The FLDL0100,
FLDL0200, or FLDL0300 list data section<em></em></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 remaining items, see
the following sections. For descriptions of each field in the list returned,
see <a href="#HDRLFLDD">Field Descriptions</a>.</p>
<p>When you retrieve list entry information from a user space for format
FLDL0100, 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.</p>
<p><em></em>When you retrieve
list entry information from a user space for format FLDL0200 or FLDL0300, you
must use the length provided at the beginning of format FLDL0200 or FLDL0300 as
a displacement to the next list entry. If you do not use the length provided in
FLDL0200 or FLDL0300, the result may not be valid.</p>
<p>For examples of how to process lists, see the <a href="../apiref/apiexmp.htm">API
examples</a>.</p>
<br>
<h3><a name="HDRFLDLIP1">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(10)</td>
<td align="left" valign="top">Record format name specified</td>
</tr>
<tr>
<td align="center" valign="top">58</td>
<td align="center" valign="top">3A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Override processing</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFLDLHD2">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(10)</td>
<td align="left" valign="top">Record format name used</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">Record length</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</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">57</td>
<td align="center" valign="top">39</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">107</td>
<td align="center" valign="top">6B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">108</td>
<td align="center" valign="top">6C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Record text description CCSID</td>
</tr>
<tr>
<td align="center" valign="top">112</td>
<td align="center" valign="top">70</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Variable length fields in format indicator</td>
</tr>
<tr>
<td align="center" valign="top">113</td>
<td align="center" valign="top">71</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Graphic fields indicator</td>
</tr>
<tr>
<td align="center" valign="top">114</td>
<td align="center" valign="top">72</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Date and time fields indicator</td>
</tr>
<tr>
<td align="center" valign="top">115</td>
<td align="center" valign="top">73</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Null-capable fields indicator</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFLDLLS1">FLDL0100 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%">Field name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Data type</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="center" valign="top">B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Use</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">Output buffer position</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">Input buffer position</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">Field length in bytes</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">Digits</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">Decimal position</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">Field 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">Edit code</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">Edit word length</td>
</tr>
<tr>
<td align="center" valign="top">88</td>
<td align="center" valign="top">58</td>
<td align="left" valign="top">CHAR(64)</td>
<td align="left" valign="top">Edit word</td>
</tr>
<tr>
<td align="center" valign="top">152</td>
<td align="center" valign="top">98</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Column heading 1</td>
</tr>
<tr>
<td align="center" valign="top">172</td>
<td align="center" valign="top">AC</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Column heading 2</td>
</tr>
<tr>
<td align="center" valign="top">192</td>
<td align="center" valign="top">C0</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Column heading 3</td>
</tr>
<tr>
<td align="center" valign="top">212</td>
<td align="center" valign="top">D4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Internal field name</td>
</tr>
<tr>
<td align="center" valign="top">222</td>
<td align="center" valign="top">DE</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Alternative field name</td>
</tr>
<tr>
<td align="center" valign="top">252</td>
<td align="center" valign="top">FC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of alternative field name</td>
</tr>
<tr>
<td align="center" valign="top">256</td>
<td align="center" valign="top">100</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of DBCS characters</td>
</tr>
<tr>
<td align="center" valign="top">260</td>
<td align="center" valign="top">104</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Null values allowed</td>
</tr>
<tr>
<td align="center" valign="top">261</td>
<td align="center" valign="top">105</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Host variable indicator</td>
</tr>
<tr>
<td align="center" valign="top">262</td>
<td align="center" valign="top">106</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Date and time format</td>
</tr>
<tr>
<td align="center" valign="top">266</td>
<td align="center" valign="top">10A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Date and time separator</td>
</tr>
<tr>
<td align="center" valign="top">267</td>
<td align="center" valign="top">10B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Variable length field indicator (overlay for MI
mapping)</td>
</tr>
<tr>
<td align="center" valign="top">268</td>
<td align="center" valign="top">10C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Field text description CCSID</td>
</tr>
<tr>
<td align="center" valign="top">272</td>
<td align="center" valign="top">110</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Field data CCSID</td>
</tr>
<tr>
<td align="center" valign="top">276</td>
<td align="center" valign="top">114</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Field column headings CCSID</td>
</tr>
<tr>
<td align="center" valign="top">280</td>
<td align="center" valign="top">118</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Field edit words CCSID</td>
</tr>
<tr>
<td align="center" valign="top">284</td>
<td align="center" valign="top">11C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">UCS-2 displayed field length</td>
</tr>
<tr>
<td align="center" valign="top">288</td>
<td align="center" valign="top">120</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Field data encoding scheme</td>
</tr>
<tr>
<td align="center" valign="top">292</td>
<td align="center" valign="top">124</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum large object field length</td>
</tr>
<tr>
<td align="center" valign="top">296</td>
<td align="center" valign="top">128</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Pad length for large object</td>
</tr>
<tr>
<td align="center" valign="top">300</td>
<td align="center" valign="top">12C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of user-defined type name</td>
</tr>
<tr>
<td align="center" valign="top">304</td>
<td align="center" valign="top">130</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">User-defined type name</td>
</tr>
<tr>
<td align="center" valign="top">432</td>
<td align="center" valign="top">1B0</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User-defined type library name</td>
</tr>
<tr>
<td align="center" valign="top">442</td>
<td align="center" valign="top">1BA</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Datalink link control</td>
</tr>
<tr>
<td align="center" valign="top">443</td>
<td align="center" valign="top">1BB</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Datalink integrity</td>
</tr>
<tr>
<td align="center" valign="top">444</td>
<td align="center" valign="top">1BC</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Datalink read permission</td>
</tr>
<tr>
<td align="center" valign="top">445</td>
<td align="center" valign="top">1BD</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Datalink write permission</td>
</tr>
<tr>
<td align="center" valign="top">446</td>
<td align="center" valign="top">1BE</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Datalink recovery</td>
</tr>
<tr>
<td align="center" valign="top">447</td>
<td align="center" valign="top">1BF</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Datalink unlink control</td>
</tr>
<tr>
<td align="center" valign="top">448</td>
<td align="center" valign="top">1C0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">
Display or print row number</td>
</tr>
<tr>
<td align="center" valign="top">452</td>
<td align="center" valign="top">1C4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Display or print column number</td>
</tr>
<tr>
<td align="center" valign="top">456</td>
<td align="center" valign="top">1C8</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">ROWID column</td>
</tr>
<tr>
<td align="center" valign="top">457</td>
<td align="center" valign="top">1C9</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Identity column</td>
</tr>
<tr>
<td align="center" valign="top">458</td>
<td align="center" valign="top">1CA</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">GENERATED BY</td>
</tr>
<tr>
<td align="center" valign="top">459</td>
<td align="center" valign="top">1CB</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Identity column - CYCLE</td>
</tr>
<tr>
<td align="center" valign="top">460</td>
<td align="center" valign="top">1CC</td>
<td align="left" valign="top">DECIMAL(31,0)</td>
<td align="left" valign="top">Identity column - Original START WITH</td>
</tr>
<tr>
<td align="center" valign="top">476</td>
<td align="center" valign="top">1DC</td>
<td align="left" valign="top">DECIMAL(31,0)</td>
<td align="left" valign="top">Identity column - Current START WITH</td>
</tr>
<tr>
<td align="center" valign="top">492</td>
<td align="center" valign="top">1EC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Identity column - INCREMENT BY</td>
</tr>
<tr>
<td align="center" valign="top">496</td>
<td align="center" valign="top">1F0</td>
<td align="left" valign="top">DECIMAL(31,0)</td>
<td align="left" valign="top">Identity column - MINVALUE</td>
</tr>
<tr>
<td align="center" valign="top">512</td>
<td align="center" valign="top">200</td>
<td align="left" valign="top">DECIMAL(31,0)</td>
<td align="left" valign="top">Identity column - MAXVALUE</td>
</tr>
<tr>
<td align="center" valign="top">528</td>
<td align="center" valign="top">210</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Identity column - CACHE</td>
</tr>
<tr>
<td align="center" valign="top">532</td>
<td align="center" valign="top">214</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Identity column - ORDER</td>
</tr>
<tr>
<td align="center" valign="top">533</td>
<td align="center" valign="top">215</td>
<td align="left" valign="top">CHAR(11)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFLDLLS2">FLDL0200 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%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Length of FLDL0200 format</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">Displacement to default value</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">Length of default value</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top"></td>
<td align="left" valign="top">All fields defined by FLDL0100 format</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" width="98%">Default value</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFLDLLS3">FLDL0300 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%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Length of FLDL0300 format</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">Displacement to all fields defined by FLDL0100
format</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">Displacement to alternative field name</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">Displacement to default value</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of default value</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">All fields defined by FLDL0100 format</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">Alternative field name (long)</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">Default value</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRLFLDD">Field Descriptions</a></h3>
<p><strong>Alternative field name.</strong> The alternative name of the field
the entry describes. This is the
DDS keyword ALIAS or a long column name in SQL. If the length of the
alternative name is greater than 30, the Alternative field name will contain
blanks. If the FLDL0300 format is used, the Alternative field name (long) will
always contain the alternative name.</p>
<p><strong>Alternative field
name (long).</strong> The alternative name of the field the entry describes.
This is the DDS keyword ALIAS or a long column name in SQL.</p>
<p><strong>Column heading 1.</strong> The description of the first column
heading for this field. It contains blanks if the heading is not defined.</p>
<p><strong>Column heading 2.</strong> The description of the second column
heading for this field. It contains blanks if the heading is not defined.</p>
<p><strong>Column heading 3.</strong> The description of the third column
heading for this field. It contains blanks if the heading is not defined.</p>
<p><strong>Data type.</strong> The type of field:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>A</em></td>
<td align="left" valign="top">Alphanumeric (character)</td>
</tr>
<tr>
<td align="left" valign="top"><em>B</em></td>
<td align="left" valign="top">Binary</td>
</tr>
<tr>
<td align="left" valign="top"><em>D</em></td>
<td align="left" valign="top">Digits only</td>
</tr>
<tr>
<td align="left" valign="top"><em>E</em></td>
<td align="left" valign="top">Either DBCS or alphanumeric</td>
</tr>
<tr>
<td align="left" valign="top"><em>F</em></td>
<td align="left" valign="top">Floating point</td>
</tr>
<tr>
<td align="left" valign="top"><em>G</em></td>
<td align="left" valign="top">Graphic data type</td>
</tr>
<tr>
<td align="left" valign="top"><em>H</em></td>
<td align="left" valign="top">Hexadecimal</td>
</tr>
<tr>
<td align="left" valign="top"><em>I</em></td>
<td align="left" valign="top">Inhibit entry</td>
</tr>
<tr>
<td align="left" valign="top"><em>J</em></td>
<td align="left" valign="top">Double-byte character set (DBCS) data only</td>
</tr>
<tr>
<td align="left" valign="top"><em>L</em></td>
<td align="left" valign="top">Date</td>
</tr>
<tr>
<td align="left" valign="top"><em>M</em></td>
<td align="left" valign="top">Numeric only</td>
</tr>
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">Numeric shift</td>
</tr>
<tr>
<td align="left" valign="top"><em>O</em></td>
<td align="left" valign="top">(Open) Both DBCS and alphanumeric</td>
</tr>
<tr>
<td align="left" valign="top"><em>P</em></td>
<td align="left" valign="top">Packed decimal</td>
</tr>
<tr>
<td align="left" valign="top"><em>S</em></td>
<td align="left" valign="top">Zoned decimal</td>
</tr>
<tr>
<td align="left" valign="top"><em>T</em></td>
<td align="left" valign="top">Time</td>
</tr>
<tr>
<td align="left" valign="top"><em>W</em></td>
<td align="left" valign="top">Katakana</td>
</tr>
<tr>
<td align="left" valign="top"><em>X</em></td>
<td align="left" valign="top">Alphabetic only (character)</td>
</tr>
<tr>
<td align="left" valign="top"><em>Y</em></td>
<td align="left" valign="top">Numeric only</td>
</tr>
<tr>
<td align="left" valign="top"><em>Z</em></td>
<td align="left" valign="top">Timestamp</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Binary large object (BLOB)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Character large object (CLOB)</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Graphic data large object (DBCLOB)</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Datalink</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">Binary character</td>
</tr>
</table>
<p><strong>Datalink integrity.</strong> How the control of the file is handled.
This value applies to datalink fields. A <strong>datalink</strong> is a field
data type that is used to point to another object that contains the data for
that field. If the datalink link control field is 0 (no link control), this
field is not applicable. 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">All linked files are under control of the
database.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">All linked files are under selective database
control if the server has the Datalink File Manager installed.</td>
</tr>
</table>
<p><strong>Datalink link control.</strong> Whether the file should be linked by
the Datalink File Manager. The <strong>Datalink File Manager</strong> is a
function that tracks which files are linked to a specific database file. This
value applies to datalink fields. 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">No link control.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">File link control.</td>
</tr>
</table>
<p><strong>Datalink read permission.</strong> The check that is done to read
the file. This value applies to datalink fields. If the datalink link control
field is 0 (no link control), this field is not applicable. 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">The database controls whether a user has read
authority.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The file system controls whether a user has read
authority.</td>
</tr>
</table>
<p><strong>Datalink recovery.</strong> Whether file recovery is done. This
value applies to datalink fields. If the datalink link control field is 0 (no
link control), this field is not applicable. 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">Recovery is not done.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Recovery is done.</td>
</tr>
</table>
<p><strong>Datalink unlink control.</strong> The action that is done to a file
during an unlink operation. This value applies to datalink fields. If the
datalink link control field is 0 (no link control) or the datalink write
permission field is 1 (File system control), this field is not applicable. 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">Restore the file owner and file authorities that
existed prior to the file link when an unlink operation occurs.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Delete the file when an unlink operation
occurs.</td>
</tr>
</table>
<p><strong>Datalink write permission.</strong> The check that is done to write
to the file. This value applies to datalink fields. If the datalink link
control field is 0 (no link control), this field is not applicable. 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">The file is blocked from accepting writing.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The file system controls whether a user has write
authority.</td>
</tr>
</table>
<p><strong>Date and time fields indicator.</strong> Whether this format
contains date and time fields. 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">The format does not contain date and time
fields.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The format contains date and time fields.</td>
</tr>
</table>
<p><strong>Date and time format.</strong> This value applies to date, time, and
timestamp fields. It also may apply to packed decimal, zoned decimal, and
character fields in a logical file. The possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*USA</em></td>
<td align="left" valign="top">IBM USA standard (mm/dd/yyyy, hh:mm a.m., hh:mm
p.m.)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ISO</em></td>
<td align="left" valign="top">International Standards Organization (yyyy-mm-dd,
hh.mm.ss)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*EUR</em></td>
<td align="left" valign="top">IBM European Standard (dd.mm.yyyy, hh.mm.ss)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*JIS</em></td>
<td align="left" valign="top">Japanese Industrial Standard Christian Era
(yyyy-mm-dd, hh:mm:ss)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SAA</em></td>
<td align="left" valign="top">SAA timestamp</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MDY</em></td>
<td align="left" valign="top">Month/day/year (mm/DD/yy)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DMY</em></td>
<td align="left" valign="top">Day/month/year (DD/mm/yy)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YMD</em></td>
<td align="left" valign="top">Year/month/day (yy/mm/DD)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*JUL</em></td>
<td align="left" valign="top">Julian (yy/ddd)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*HMS</em></td>
<td align="left" valign="top">Hour/minute/second (hh:mm:Ss)</td>
</tr>
<tr>
<td align="left" valign="top"><em>MDYY</em></td>
<td align="left" valign="top">Month/day/year (mm/DD/yyyy)</td>
</tr>
<tr>
<td align="left" valign="top"><em>DMYY</em></td>
<td align="left" valign="top">Day/month/year (DD/mm/yyyy)</td>
</tr>
<tr>
<td align="left" valign="top"><em>YYMD</em></td>
<td align="left" valign="top">Year/month/day (yyyy/mm/DD)</td>
</tr>
<tr>
<td align="left" valign="top"><em>JUL4</em></td>
<td align="left" valign="top">Long Julian (yyyy/ddd)</td>
</tr>
<tr>
<td align="left" valign="top"><em>CMDY</em></td>
<td align="left" valign="top">Century/month/day/year (c/mm/DD/yy)</td>
</tr>
<tr>
<td align="left" valign="top"><em>CDMY</em></td>
<td align="left" valign="top">Century/day/month/year (c/DD/mm/yy)</td>
</tr>
<tr>
<td align="left" valign="top"><em>CYMD</em></td>
<td align="left" valign="top">Century/year/month/day (c/yy/mm/DD)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MY</em></td>
<td align="left" valign="top">Month/year (mm/yy)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YM</em></td>
<td align="left" valign="top">Year/month (yy/mm)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MYY</em></td>
<td align="left" valign="top">Month/year (mm/yyyy)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YYM</em></td>
<td align="left" valign="top">Year/month (yyyy/mm)</td>
</tr>
</table>
<p><strong>Date and time separator.</strong> This value applies only to date or
time fields. The possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>/</em></td>
<td align="left" valign="top">Slash separator</td>
</tr>
<tr>
<td align="left" valign="top"><em>-</em></td>
<td align="left" valign="top">Dash separator</td>
</tr>
<tr>
<td align="left" valign="top"><em>.</em></td>
<td align="left" valign="top">Period separator</td>
</tr>
<tr>
<td align="left" valign="top"><em>,</em></td>
<td align="left" valign="top">Comma Separator</td>
</tr>
<tr>
<td align="left" valign="top"><em>:</em></td>
<td align="left" valign="top">Colon separator</td>
</tr>
<tr>
<td align="left" valign="top"><em>(blank)</em></td>
<td align="left" valign="top">Blank separator</td>
</tr>
</table>
<p><strong>Note:</strong> If the date and time separator field returns a blank,
the separator may have been determined by the default for the specified value
of the date and time format field.</p>
<p><strong>Decimal position.</strong> The number of decimal positions. This
entry is zero if the field is not numeric.</p>
<p><strong>Default value.</strong> The default value for this field. The
default value is defined by the DFT or DFTVAL keyword used in DDS, or by the
WITH DEFAULT clause of the CREATE TABLE SQL statement. Some examples of
returned data are:<br>
</p>
<table border width="80%">
<tr>
<th align="left" valign="top">SQL clause WITH DEFAULT value, where value
is:</th>
<th align="left" valign="top">DDS keyword DFT(value), where value is:</th>
<th align="left" valign="top">Returned by API:</th>
</tr>
<tr>
<td align="left" valign="top" width="33%">'ABC'</td>
<td align="left" valign="top" width="33%">'ABC'</td>
<td align="left" valign="top" width="33%">'ABC'</td>
</tr>
<tr>
<td align="left" valign="top">+999</td>
<td align="left" valign="top">+999</td>
<td align="left" valign="top">+999</td>
</tr>
<tr>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">999</td>
<td align="left" valign="top">+999</td>
</tr>
<tr>
<td align="left" valign="top">999</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">999</td>
</tr>
<tr>
<td align="left" valign="top">-999</td>
<td align="left" valign="top">-999</td>
<td align="left" valign="top">-999</td>
</tr>
<tr>
<td align="left" valign="top">USER<br>
<strong>Note:</strong> This value means to use the User ID as the value.</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">USER</td>
</tr>
<tr>
<td align="left" valign="top">COCODE ( 'ABC' )</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">COCODE ( 'ABC' )</td>
</tr>
</table>
<p><strong>Digits.</strong> The number of digits. This entry is zero if the
field is not numeric.</p>
<p> <strong>Displacement to all
fields defined by FLDL0100 format.</strong> This field contains the offset from
the beginning of this entry to the beginning of the data mapped by the FLDL0100
format.</p>
<p><strong>Displacement to alternative field name.</strong> This field contains
the offset from the beginning of this entry to the beginning of the alternative
field name. This field is zero if there is no alternative field name.</p>
<p><strong>Displacement to default value.</strong> This field contains the
offset from the beginning of this entry to the beginning of the default data.
This field is zero if there is no default data for the field.</p>
<p><strong>Display or print column number.</strong> This field contains the
column number specified in the DDS source or as calculated at compile-time by
the DDS compiler. If this value was not calculated at compile-time, it will be
set to -1.</p>
<p><strong>Display or print row number.</strong> This field contains the row
number specified in the DDS source. This value will be relative to the start of
the format. If spacing keywords (such as SPACEA, SKIPA, and SLNO) were
specified for the file, record or field, this value will be set to -1.</p>
<p><strong>Edit code.</strong> The field edit code.</p>
<p><strong>Edit word.</strong> The field edit word.</p>
<p><strong>Edit word length.</strong> The length of the edit word used.</p>
<p><strong>Field column headings CCSID.</strong></p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">There are no field column headings.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-65,535</em></td>
<td align="left" valign="top">The CCSID for the field column headings.</td>
</tr>
</table>
<p><strong>Field data CCSID.</strong></p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">There is no field data.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-65,535</em></td>
<td align="left" valign="top">The CCSID for the field data.</td>
</tr>
</table>
<p><strong>Field data encoding scheme.</strong> The encoding scheme associated
with the field data CCSID.</p>
<p><strong>Field edit words CCSID</strong></p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">There are no field edit words.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-65,535</em></td>
<td align="left" valign="top">The CCSID for the field edit words.</td>
</tr>
</table>
<p><strong>Field length in bytes.</strong> The number of bytes the field
occupies.</p>
<p><strong>Field name.</strong> The name of the field the entry describes.</p>
<p><strong>Field text description.</strong> The description of the field.</p>
<p><strong>Field text description CCSID.</strong></p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">There is no field text description.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-65,535</em></td>
<td align="left" valign="top">The CCSID for the field text description.</td>
</tr>
</table>
<p><strong>Record text description CCSID.</strong></p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">There is no record text description.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-65,535</em></td>
<td align="left" valign="top">The CCSID for the record text description.</td>
</tr>
</table>
<p><strong>File library name specified.</strong> The 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.</p>
<p><strong>File name specified.</strong> The file specified in the call to the
API.</p>
<p><strong>File name used.</strong> The name of the file where the member list
was found.</p>
<p><strong>File type.</strong> The type of file found.</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</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</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>
</table>
<p><strong>Format name.</strong> The content and format of the information
returned for each field. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>FLDL0100</em></td>
<td align="left" valign="top">Field information</td>
</tr>
<tr>
<td align="left" valign="top"><em>FLDL0200</em></td>
<td align="left" valign="top">Field and default value information</td>
</tr>
<tr>
<td align="left" valign="top"><em>FLDL0300</em></td>
<td align="left" valign="top">Field, alternative field name, and default value
information</td>
</tr>
</table>
<p><strong>GENERATED
BY.</strong> This value defines when DB2 will generate a value for the column
when a row is inserted or updated in a table. If the identity column field is 0
and the ROWID column field is 0, this field is not applicable. The possible
values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">BY DEFAULT - Indicates that DB2 will generate a
value for the column when a row is inserted or updated in a table unless a
value is specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">ALWAYS - Indicates that DB2 will always generate
a value for the column when a row is inserted or updated in a table.</td>
</tr>
</table>
<p><strong>Graphic fields indicator.</strong> Whether this format contains
graphic fields. 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">The format does not contain graphic fields.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The format does contain graphic fields.</td>
</tr>
</table>
<p><strong>Host variable indicator.</strong> Whether a query has been defined
with a host variable or a parameter marker in place of a comparison operand
(for example, FIELDA &gt; :hostvar) or an arithmetic operand (for example,
FIELDA * 10). Possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The query definition does not contain a host
variable or a parameter marker.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The query definition does contain a host variable
or a parameter marker.</td>
</tr>
</table>
<p><strong>Identity
column.</strong> This value specifies whether or not this column was created as
an identity column. 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">This is not an identity column.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This is an identity column.</td>
</tr>
</table>
<p><strong>Identity column - CACHE.</strong> This value is the number of cached
values. If the Identity column field is 0 (no value specified), this field is
not applicable.</p>
<p><strong>Identity column - CYCLE.</strong> This value specifies whether this
identity column should continue to generate values after generating either its
maximum or minimum value. If the identity column field is 0, this field is not
applicable. 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">This identity column should not continue to
generate values after generating either its minimum or maximum value.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This identity column should continue to generate
values after generating either its minimum or maximum value.</td>
</tr>
</table>
<p><strong>Identity column - INCREMENT BY.</strong> This value specifies the
interval between consecutive values of the identity column. This value applies
to identity column fields. If this value is positive, this is an ascending
identity column. If the value is negative, this is a descending identity
column. If the identity column field is 0, this field is not applicable.</p>
<p><strong>Identity column - MAXVALUE.</strong> This value specifies the
maximum value at which an ascending identity column either cycles or stops
generating values, or a descending identity column cycles to after reaching the
minimum value. If the identity column field is 0, this field is not
applicable.</p>
<p><strong>Identity column - MINVALUE.</strong> This value specifies the
minimum value at which a descending identity column either cycles or stops
generating values, or an ascending identity column cycles to after reaching the
maximum value. This value applies to identity column fields. If the identity
column field is 0, this field is not applicable.</p>
<p><strong>Identity column - ORDER.</strong> This value specifies whether the
identity values must be generated in order of request. If the identity column
field is 0, this field is not applicable. 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">Identity values need not be generated in order of
request.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Identity values must be generated in order of
request.</td>
</tr>
</table>
<p><strong>Identity column - Original START WITH.</strong> This value specifies
the first value for the identity column as defined when the table was created.
If the identity column field is 0, this field is not applicable.</p>
<p><strong>Identity column - Current START WITH.</strong> This value specifies
the first value for the identity column. If the START WITH value for the
identity column was changed through the ALTER TABLE command, this value will
show the current setting. If the identity column field is 0, this field is not
applicable.</p>
<p><strong>Input buffer position.</strong> The field's position within the
input record.</p>
<p><strong>Internal field name.</strong> The internal name used to identify the
field the entry describes.</p>
<p><strong>Length of alternative field name.</strong> The length of the
alternative field name definition.</p>
<p><strong>Length of default value.</strong> The length of the default value
for this field. If the field has no default value, this field is zero.</p>
<p><strong>Length of FLDL0200 format.</strong> The combined length of all data
returned in format FLDL0200. Use this value to access the next list data
entry.</p>
<p><strong>Length of FLDL0300
format.</strong> The combined length of all data returned in format FLDL0300.
Use this value to access the next list data entry.</p>
<p><strong>Length of user-defined type name.</strong> The length of the
user-defined type name. If the field has no user-defined type, this field is
zero.</p>
<p><strong>Maximum large object field length.</strong> The maximum length of
data that can be contained for this field. This value applies to fields with
the BLOB, CLOB or DBCLOB data type.</p>
<p><strong>Null-capable fields indicator.</strong> Whether this format contains
null-capable fields. 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">The format does not contain null-capable
fields.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The format contains null-capable fields.</td>
</tr>
</table>
<p><strong>Null values allowed.</strong> Whether the result of this field can
be the null value. 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">The field does not allow the null value.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The field does allow the null value.</td>
</tr>
</table>
<p><strong>Number of DBCS characters.</strong> The number of DBCS characters
this field can contain if the field type is graphic data type. This value does
not include the 2 bytes for the variable length portion of the field.</p>
<p><strong>Offset to default value.</strong> The offset from the beginning of
format FLDL0200 to the start of the default value for this field. If the field
has no default value, this value is zero.</p>
<p><strong>Output buffer position.</strong> The field's position within the
output record.</p>
<p><strong>Override processing.</strong> Whether overrides are to be processed.
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">No override processing</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Override processing</td>
</tr>
</table>
<p><strong>Pad length for large object.</strong> This value applies fields with
the BLOB, CLOB or DBCLOB data type. This value is the pad length of the buffer
for this field.</p>
<p><strong>Record format ID.</strong> The record format identifier.</p>
<p><strong>Record format name specified.</strong> The record format specified
in the call to the API.</p>
<p><strong>Record format name used.</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>Record text description CCSID.</strong></p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">There is no record text description.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-65,535</em></td>
<td align="left" valign="top">The CCSID for the record text description.</td>
</tr>
</table>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>ROWID
column.</strong> This value specifies that this field has been designated as a
ROWID column. 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">The ROWID attribute was not specified on this
field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This field was created with the ROWID
attribute.</td>
</tr>
</table>
<p><strong>UCS-2 displayed field length.</strong> The display length of a field
containing UCS-2 data. This value is zero if the field does not contain UCS-2
data. For information about UCS-2, see the <a href=
"../nls/rbagsglobalmain.htm">Globalization</a> topic in the iSeries Information
Center.</p>
<p><strong>User-defined type name.</strong> The name of the user-defined type
object.</p>
<p><strong>User-defined type library name.</strong> The library containing the
user-defined type object.</p>
<p><strong>Use.</strong> How the field is used:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>I</em></td>
<td align="left" valign="top">Input</td>
</tr>
<tr>
<td align="left" valign="top"><em>O</em></td>
<td align="left" valign="top">Output</td>
</tr>
<tr>
<td align="left" valign="top"><em>B</em></td>
<td align="left" valign="top">Both input and output</td>
</tr>
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">Neither</td>
</tr>
</table>
<p><strong>Note:</strong> Use is from the program point of view and not
necessarily the use specified in the DDS that created the file. For example,
*DSPF subfile record fields return <strong>B</strong> even if the field is
<strong>O</strong> in the DDS.</p>
<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>
<p><strong>Variable length field indicator (overlay for MI mapping).</strong>
Whether the field has been defined as *VARCHAR, VARLEN, or *VARGRF. 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">The field is not variable length.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The field is variable length.</td>
</tr>
</table>
<p><strong>Variable length fields in format indicator.</strong> Whether this
format contains variable length fields. 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">The format does not contain variable length
fields.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The format contains variable length fields.</td>
</tr>
</table>
<br>
<br>
<h3>Error Messages</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">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</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">CPF3C20 E</td>
<td align="left" valign="top">Error found by program &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C22 E</td>
<td align="left" valign="top">Cannot get information about file &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C25 E</td>
<td align="left" valign="top">Value &amp;1 for file override parameter is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C28 E</td>
<td align="left" valign="top">Record format &amp;3 in file &amp;1 not
found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this
API was not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8100 E</td>
<td align="left" valign="top">All CPF81xx messages could be returned. xx is
from 01 to FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9800 E</td>
<td align="left" valign="top">All CPF98xx messages could be signaled. xx is
from 01 to FF.</td>
</tr>
</table>
<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>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink