85 lines
4.7 KiB
HTML
85 lines
4.7 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="List sections" />
|
||
|
|
<meta name="abstract" content="Each list API provides a input parameter, header, and list data section." />
|
||
|
|
<meta name="description" content="Each list API provides a input parameter, header, and list data section." />
|
||
|
|
<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="usflistsection" />
|
||
|
|
<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>List sections</title>
|
||
|
|
</head>
|
||
|
|
<body id="usflistsection"><a name="usflistsection"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">List sections</h1>
|
||
|
|
<div><p>Each list API provides a input parameter, header, and list data
|
||
|
|
section.</p>
|
||
|
|
<div class="section">
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e19">List Section</th>
|
||
|
|
<th valign="top" id="d0e21">Contents</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e19 ">Input parameter section</td>
|
||
|
|
<td valign="top" headers="d0e21 ">An exact copy of the parameters coded in the call to the API. In general,
|
||
|
|
this section contains all the parameters available.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e19 ">Header section</td>
|
||
|
|
<td valign="top" headers="d0e21 ">Parameter feedback and global information about each object. Some APIs
|
||
|
|
do not use this section; in those cases, the value of the size-of-header-section
|
||
|
|
field is zero.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e19 ">List data section</td>
|
||
|
|
<td valign="top" headers="d0e21 ">The generated list data. All entries in the list section are the same
|
||
|
|
length.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>When you retrieve list entry information from a user space, you
|
||
|
|
should use the entry size designated in your application. To get the next
|
||
|
|
entry, use the entry size returned in the generic header. 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>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="usflistsection__HDRPARTLST"><a name="usflistsection__HDRPARTLST"><!-- --></a><h4 class="sectiontitle">Partial list considerations</h4><p>Some
|
||
|
|
APIs may be able to return more information to the application than fits in
|
||
|
|
a receiver variable or a user space. The information returned is correct,
|
||
|
|
but not complete.</p>
|
||
|
|
<p>If the list information is not complete, the first
|
||
|
|
item and possibly the second item occur:</p>
|
||
|
|
<ul><li>A <em>P</em> is returned in the information status field of the generic
|
||
|
|
user space layout; refer to <a href="usfgeneral.htm">General data structure</a>.</li>
|
||
|
|
<li>The API supports a continuation handle.</li>
|
||
|
|
</ul>
|
||
|
|
<p>If an indicator of a partial list is returned, the application should
|
||
|
|
call the API again with the continuation handle in the list header section
|
||
|
|
of the API and specify that the list begin with the next entry to be returned.</p>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> If
|
||
|
|
this is the first time the API is attempting to return information, the continuation
|
||
|
|
handle must be set to blanks. If the API does not support a continuation handle,
|
||
|
|
you need to call the API again and use more restrictive values for the parameters.</div>
|
||
|
|
</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>
|