303 lines
15 KiB
HTML
303 lines
15 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="reference" />
|
||
|
|
<meta name="DC.Title" content="Common data structure formats" />
|
||
|
|
<meta name="abstract" content="This topic shows the generic user space layout. Format 0100 shows the format for an original program model (OPM) layout. Format 0300 shows the format for an Integrated Language Environment (ILE) model layout. The fields are described in detail after the table." />
|
||
|
|
<meta name="description" content="This topic shows the generic user space layout. Format 0100 shows the format for an original program model (OPM) layout. Format 0300 shows the format for an Integrated Language Environment (ILE) model layout. The fields are described in detail after the table." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="usf.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="usfcommonstructure" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- 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. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>Common data structure formats</title>
|
||
|
|
</head>
|
||
|
|
<body id="usfcommonstructure"><a name="usfcommonstructure"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">Common data structure formats</h1>
|
||
|
|
<div><p>This topic shows the generic user space layout. Format 0100 shows
|
||
|
|
the format for an original program model (OPM) layout. Format 0300 shows the
|
||
|
|
format for an Integrated
|
||
|
|
Language Environment<sup>®</sup> (ILE) model layout. The fields are described in
|
||
|
|
detail after the table.</p>
|
||
|
|
<div class="section" id="usfcommonstructure__Header_32"><a name="usfcommonstructure__Header_32"><!-- --></a><h4 class="sectiontitle">Generic header format 0100</h4></div>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e26">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e28">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e30">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e33">Dec</th>
|
||
|
|
<th valign="top" id="d0e35">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e26 d0e33 ">0</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">0</td>
|
||
|
|
<td valign="top" headers="d0e28 ">CHAR(64)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">User area</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">64</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">40</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Size of generic header</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">68</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">44</td>
|
||
|
|
<td valign="top" headers="d0e28 ">CHAR(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Structure's release and level</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">72</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">48</td>
|
||
|
|
<td valign="top" headers="d0e28 ">CHAR(8)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Format name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">80</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">50</td>
|
||
|
|
<td valign="top" headers="d0e28 ">CHAR(10)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">API used</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">90</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">5A</td>
|
||
|
|
<td valign="top" headers="d0e28 ">CHAR(13)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Date and time created</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">103</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">67</td>
|
||
|
|
<td valign="top" headers="d0e28 ">CHAR(1)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Information status</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">104</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">68</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Size of user space used</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">108</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">6C</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Offset to input parameter section</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">112</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">70</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Size of input parameter section</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">116</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">74</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Offset to header section</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">120</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">78</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Size of header section</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">124</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">7C</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Offset to list data section</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">128</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">80</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Size of list data section</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">132</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">84</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Number of list entries</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">136</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">88</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Size of each entry</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">140</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">8C</td>
|
||
|
|
<td valign="top" headers="d0e28 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">CCSID of data in the list entries</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">144</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">90</td>
|
||
|
|
<td valign="top" headers="d0e28 ">CHAR(2)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Country or region ID</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">146</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">92</td>
|
||
|
|
<td valign="top" headers="d0e28 ">CHAR(3)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Language ID</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">149</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">95</td>
|
||
|
|
<td valign="top" headers="d0e28 ">CHAR(1)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Subsetted list indicator</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e26 d0e33 ">150</td>
|
||
|
|
<td valign="top" headers="d0e26 d0e35 ">96</td>
|
||
|
|
<td valign="top" headers="d0e28 ">CHAR(42)</td>
|
||
|
|
<td valign="top" headers="d0e30 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="usfcommonstructure__Header_33"><a name="usfcommonstructure__Header_33"><!-- --></a><h4 class="sectiontitle">Generic header format 0300</h4></div>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e238">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e240">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e242">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e245">Dec</th>
|
||
|
|
<th valign="top" id="d0e247">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e238 d0e245 ">0</td>
|
||
|
|
<td valign="top" headers="d0e238 d0e247 ">0</td>
|
||
|
|
<td valign="top" headers="d0e240 "> </td>
|
||
|
|
<td valign="top" headers="d0e242 ">Everything from the 0100 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e238 d0e245 ">192</td>
|
||
|
|
<td valign="top" headers="d0e238 d0e247 ">C0</td>
|
||
|
|
<td valign="top" headers="d0e240 ">CHAR(256)</td>
|
||
|
|
<td valign="top" headers="d0e242 ">API entry point name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e238 d0e245 ">448</td>
|
||
|
|
<td valign="top" headers="d0e238 d0e247 ">1C0</td>
|
||
|
|
<td valign="top" headers="d0e240 ">CHAR(128)</td>
|
||
|
|
<td valign="top" headers="d0e242 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="usfcommonstructure__Header_34"><a name="usfcommonstructure__Header_34"><!-- --></a><h4 class="sectiontitle">Field descriptions</h4><p>This topic describes
|
||
|
|
the fields returned in further detail. Field descriptions are in alphabetical
|
||
|
|
order.</p>
|
||
|
|
<p><span class="uicontrol">API entry point name.</span> The name of the
|
||
|
|
ILE bindable API entry point that generated the list.</p>
|
||
|
|
<p><span class="uicontrol">API
|
||
|
|
used.</span> For format 0100, this is the name of the original program
|
||
|
|
model (OPM) API that generated the list. For format 0300, this is a reserved
|
||
|
|
field. See the API entry point name field for the API used.</p>
|
||
|
|
<p><span class="uicontrol">CCSID
|
||
|
|
of the data in the list entries.</span> The coded character set ID for
|
||
|
|
data in the list entries. If 0, then the data is not associated with a specific
|
||
|
|
CCSID and should be treated as hexadecimal data.</p>
|
||
|
|
<p><span class="uicontrol">Country
|
||
|
|
or region ID.</span> The country or region identifier of the data written
|
||
|
|
to the user space.</p>
|
||
|
|
<p><span class="uicontrol">Date and time created.</span> The
|
||
|
|
date and time when the list was created. The 13 characters are:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e308">Value</th>
|
||
|
|
<th valign="bottom" id="d0e310">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e308 "><em>1</em></td>
|
||
|
|
<td valign="top" headers="d0e310 ">Century, where 0 indicates years 19 <em>xx</em> and 1 indicates years
|
||
|
|
20 <em>xx</em>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e308 "><em>2-7</em></td>
|
||
|
|
<td valign="top" headers="d0e310 ">The date, in YYMMDD (year, month, day) format.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e308 "><em>8-13</em></td>
|
||
|
|
<td valign="top" headers="d0e310 ">The time of day, in HHMMSS (hours, minutes, seconds) format.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p><span class="uicontrol">Format name.</span> The name of the format for
|
||
|
|
the list data section.</p>
|
||
|
|
<p><span class="uicontrol">Information status.</span> Whether
|
||
|
|
or not the information is complete and accurate. Possible values are:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e351">Value</th>
|
||
|
|
<th valign="bottom" id="d0e353">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e351 "><em>C</em></td>
|
||
|
|
<td valign="top" headers="d0e353 ">Complete and accurate.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e351 "><em>I</em></td>
|
||
|
|
<td valign="top" headers="d0e353 ">Incomplete. The information you received is not accurate or complete.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e351 "><em>P</em></td>
|
||
|
|
<td valign="top" headers="d0e353 ">Partial but accurate. The information you received is accurate, but
|
||
|
|
the API had more information to return than the user space could hold. See <a href="usflistsection.htm">List sections</a> for more information about partial lists.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p><span class="uicontrol">Language ID.</span> The language identifier of
|
||
|
|
the data written to the user space.</p>
|
||
|
|
<p><span class="uicontrol">Number of list entries.</span>
|
||
|
|
The number of fixed-length entries in the list data section.</p>
|
||
|
|
<p><span class="uicontrol">Offset
|
||
|
|
to (all) section.</span> The byte offset from the beginning of the user
|
||
|
|
space to the start of the section.</p>
|
||
|
|
<p><span class="uicontrol">Reserved.</span>
|
||
|
|
An ignored field.</p>
|
||
|
|
<p><span class="uicontrol">Size of each entry.</span> The size
|
||
|
|
of each list data section entry, in bytes. All entries are the same size.
|
||
|
|
For formats that return variable length records, this is zero.</p>
|
||
|
|
<p><span class="uicontrol">Size
|
||
|
|
of generic header.</span> The size of the generic header, in bytes.
|
||
|
|
This does not include the size of the user area; refer to <a href="usfgeneral.htm">General data structure</a> for
|
||
|
|
a diagram showing the user area.</p>
|
||
|
|
<p><span class="uicontrol">Size of header section.</span>
|
||
|
|
The size of the header section, in bytes.</p>
|
||
|
|
<p><span class="uicontrol">Size of input parameter
|
||
|
|
section.</span> The size of the input parameter section, in bytes.</p>
|
||
|
|
<p><span class="uicontrol">Size
|
||
|
|
of list data section.</span> The size of the list data section, in bytes.
|
||
|
|
For formats that return variable length records, this is zero.</p>
|
||
|
|
<p><span class="uicontrol">Size
|
||
|
|
of user space used.</span> The combined size of the user area, generic
|
||
|
|
header, input parameter section, header section, and list data section, in
|
||
|
|
bytes. This determines what is changed in the user space.</p>
|
||
|
|
<p><span class="uicontrol">Structure's
|
||
|
|
release and level.</span> The release and level of the generic header
|
||
|
|
format for this list. The value of this field is 0100 for generic header format
|
||
|
|
0100 and 0300 for generic header format 0300. List APIs put this value into
|
||
|
|
the user space.</p>
|
||
|
|
<p><span class="uicontrol">Subsetted list indicator.</span> A
|
||
|
|
flag that indicates if the data selected from the list API can be stored in
|
||
|
|
that format.</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e434">Value</th>
|
||
|
|
<th valign="bottom" id="d0e436">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e434 "><em>0</em></td>
|
||
|
|
<td valign="top" headers="d0e436 ">List is not subsetted; all of the information can be stored in the
|
||
|
|
format.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e434 "><em>1</em></td>
|
||
|
|
<td valign="top" headers="d0e436 ">List is subsetted. For example, integrated file system names may be
|
||
|
|
longer than the available area in the format. See the API specific documentation
|
||
|
|
for detail.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p><span class="uicontrol">User area.</span> An area within the user space
|
||
|
|
that is provided for the caller to use to communicate system programmer-related
|
||
|
|
information between applications that use the user space.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="usf.htm" title="List APIs require a user space for returning information. A user space is an object consisting of a collection of bytes that can be used for storing any user-defined information.">User spaces</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|