244 lines
7.8 KiB
HTML
244 lines
7.8 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>Exit Program for Read Directory Entries (QHFRDDR) API</title>
|
||
|
|
<!-- 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 Edited November 2001 -->
|
||
|
|
<!--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>Exit Program for Read Directory Entries (QHFRDDR) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<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%">Operation (RDDR)</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(5)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">File system job handle</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(16)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Open directory handle</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(16)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Data buffer</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">Data buffer length</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</td>
|
||
|
|
<td align="left" valign="top">Number of directory entries to read</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="left" valign="top">Number of directory entries read</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">Length of data returned</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p><a name="SPTSCRDDR"></a>Before applications can use the Read Directory Entries (QHFRDDR) API with your file system, you must:</p>
|
||
|
|
|
||
|
|
<ol>
|
||
|
|
<li>Write an exit program that performs the read directory entries operation on behalf of the API. For a detailed description of the API and its calling parameters, see <a href="qhfrddr.htm">Read Directory Entries (QHFRDDR) API</a>.<br><br></li>
|
||
|
|
|
||
|
|
<li>Give the exit program's name when you register the file system with the Register File System (QHFRGFS) API.</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<p>After that, when an application calls the QHFRDDR API, the API calls your exit program and passes it the parameters specified by the application. Your exit program performs the work and returns any data to the API. The API passes the data back to the calling application.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
||
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<!-- Use this if there are no authorities and locks. -->
|
||
|
|
<p>None.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<p>The following shows the input parameters that the API passes to your exit program and the output parameter that the exit program must pass back to the API:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Operation (RDDR)</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(5)
|
||
|
|
|
||
|
|
<p>The abbreviation for the operation being performed (RDDR).</p></dd>
|
||
|
|
|
||
|
|
<dt><strong>File system job handle</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(16)
|
||
|
|
|
||
|
|
<p>The work area or job identifier for use by the file system.</p></dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p>The following parameters are the same as the parameters for the API.</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Open directory handle</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(16)<br><br></dd>
|
||
|
|
|
||
|
|
<dt><strong>Data buffer</strong></dt>
|
||
|
|
<dd>OUTPUT; CHAR(*)<br><br></dd>
|
||
|
|
|
||
|
|
<dt><strong>Data buffer length</strong></dt>
|
||
|
|
<dd>INPUT; BINARY(4)<br><br></dd>
|
||
|
|
|
||
|
|
<dt><strong>Number of directory entries to read</strong></dt>
|
||
|
|
<dd>INPUT; BINARY(4)<br><br></dd>
|
||
|
|
|
||
|
|
<dt><strong>Number of directory entries read</strong></dt>
|
||
|
|
<dd>OUTPUT; BINARY(4)<br><br></dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of data returned</strong></dt>
|
||
|
|
<dd>OUTPUT; BINARY(4)</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>API Functions</h3>
|
||
|
|
|
||
|
|
<p>The QHFRDDR API performs the standard functions described in <a href="hfs3d.htm#HDRSTDAPI">Standard HFS API Functions</a> and one additional function. The API validates the open directory handle to ensure that the directory is open and the current user profile is the user that opened it.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Exit Program Requirements</h3>
|
||
|
|
|
||
|
|
<p>You must create an exit program that performs the standard functions described in<a href="hfs3d.htm#HDRSTDFS"> Standard HFS Exit Program Requirements</a> and these additional functions:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>Retrieves the directory entry information. The file system should return only attributes selected with the attribute selection table when the directory was opened. The file system must build the table and set the number of directory entries actually read and the length of data returned.<br><br></li>
|
||
|
|
|
||
|
|
<li>If a requested attribute is not associated with a directory entry, returns the attribute name and the length of the attribute value, which is zero.<br><br></li>
|
||
|
|
|
||
|
|
<li>Increases the directory pointer value to reflect its new position after directory entries are read.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>In addition, your file system's documentation should describe the order in which directory entries are returned (for example, alphabetic or last-used date).</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Error Messages for Exit Program Use</h3>
|
||
|
|
|
||
|
|
<p>This section lists the messages that the exit program can return to the API.</p>
|
||
|
|
|
||
|
|
<table cellpadding="3">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F08 E</td>
|
||
|
|
<td valign="top">Damaged directory.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F41 E</td>
|
||
|
|
<td valign="top">Severe error occurred while addressing parameter list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F47 E</td>
|
||
|
|
<td valign="top">Buffer overflow occurred.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F53 E</td>
|
||
|
|
<td valign="top">Value for length of data buffer not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F62 E</td>
|
||
|
|
<td valign="top">Requested function failed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F66 E</td>
|
||
|
|
<td valign="top">Storage needed exceeds maximum limit for user profile &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F71 E</td>
|
||
|
|
<td valign="top">Exception specific to file system occurred.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F73 E</td>
|
||
|
|
<td valign="top">Not authorized to use command.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F74 E</td>
|
||
|
|
<td valign="top">Not authorized to object.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1F77 E</td>
|
||
|
|
<td valign="top">Severe parameter error occurred on call to file system.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
Exit Program Introduced: V2R1
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a
|
||
|
|
href="hfs1.htm">Hierarchical File System APIs</a> |
|
||
|
|
<a href="aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|