801 lines
23 KiB
HTML
801 lines
23 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Retrieve Network File System Export Entries (QZNFRTVE) API</title>
|
||
|
|
<!-- Begin Header Records ========================================== -->
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- file cleaned -->
|
||
|
|
<!-- Unix2 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
||
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
||
|
|
<!-- This file has undergone html cleanup June 2002 by JET -->
|
||
|
|
<!--End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>Retrieve Network File System Export Entries (QZNFRTVE) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="50%">Receiver variable</td>
|
||
|
|
<td align="left" valign="top" width="20%">Output</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Length of receiver variable in bytes</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Returned records feedback information</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(16)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</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">5</td>
|
||
|
|
<td align="left" valign="top">Object path name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</td>
|
||
|
|
<td align="left" valign="top">Length of object path name in bytes</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">CCSID of object path name given</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">Desired CCSID of the object path<br>
|
||
|
|
names returned</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">9</td>
|
||
|
|
<td align="left" valign="top">Handle</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">10</td>
|
||
|
|
<td align="left" valign="top">Error code</td>
|
||
|
|
<td align="left" valign="top">I/O</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<p>The Retrieve Network File System Export Entries (QZNFRTVE) API returns the
|
||
|
|
list of Network File System (NFS) export entries for objects currently exported
|
||
|
|
to NFS clients or for objects referenced in the /etc/exports file.<br>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The user must have execute (*X) data authority to the /etc directory (if it
|
||
|
|
exists).<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>The user must have read (*R) data authority to the /etc/exports file (if it
|
||
|
|
exists).</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> Adopted authority is not used.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
|
||
|
|
<p>If none of the required parameters are passed to this API, then all of the
|
||
|
|
entries that are currently exported will be returned to the joblog by messages
|
||
|
|
(CPIB41A). If there are no entries currently exported, then message CPIB41B
|
||
|
|
will be returned.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<p>The following parameters are required.</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt>Receiver variable</dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The receiver variable that receives the information requested. The API
|
||
|
|
returns only data that the area can hold.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt>Length of receiver variable</dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the receiver variable provided. The length of the receiver
|
||
|
|
variable parameter may be specified up to the size of the receiver variable
|
||
|
|
area specified by the user program.</p>
|
||
|
|
|
||
|
|
<p>No partial entries will be returned. If the length of the receiver variable
|
||
|
|
is less than what is required by the format selected, then an error is returned
|
||
|
|
(CPFB419) and the size required will be indicated in the feedback
|
||
|
|
structure.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt>Returned records feedback information</dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(16)
|
||
|
|
|
||
|
|
<p>Information about the entries that are returned in the receiver
|
||
|
|
variable.</p>
|
||
|
|
|
||
|
|
<p>For a detailed description of this format, see <a href="#HDRRRFINF">Format
|
||
|
|
of Returned Records Feedback Information</a>.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt>Format name</dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The name of the format that is used to retrieve NFS export entries.</p>
|
||
|
|
|
||
|
|
<p>You can specify one of the following formats:</p>
|
||
|
|
|
||
|
|
<dl compact>
|
||
|
|
<dt><strong>EXPE0100</strong></dt>
|
||
|
|
|
||
|
|
<dd>Returns information about export entries that are currently exported. These
|
||
|
|
are sometimes called temporary exports. For a detailed description of this
|
||
|
|
format, see <a href="#HDREXPE100">EXPE0100 and EXPE0200 format</a>.</dd>
|
||
|
|
|
||
|
|
<dt><strong>EXPE0200</strong></dt>
|
||
|
|
|
||
|
|
<dd>Returns information about export entries that are in the /etc/exports file.
|
||
|
|
These are sometimes called permanent exports. For a detailed description of
|
||
|
|
this format, see <a href="#HDREXPE100">EXPE0100 and EXPE0200 format</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt>Object path name</dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The object path name at which to start listing NFS export entries. Possible
|
||
|
|
values follow:</p>
|
||
|
|
|
||
|
|
<dl compact>
|
||
|
|
<dt><em>*FIRST</em></dt>
|
||
|
|
|
||
|
|
<dd>NFS export entries are returned starting with the first object path name in
|
||
|
|
the NFS export entry list.</dd>
|
||
|
|
|
||
|
|
<dt><em>*HANDLE</em></dt>
|
||
|
|
|
||
|
|
<dd>NFS export entries are returned starting with the object path name that
|
||
|
|
corresponds to the specified handle.
|
||
|
|
|
||
|
|
<p>When the receiver variable is not large enough to hold all of the entries in
|
||
|
|
the NFS export entry list, the API returns a non-zero handle in the returned
|
||
|
|
records feedback information parameter. This handle can be used on a subsequent
|
||
|
|
call to the API to continue retrieving NFS export entries with the next object
|
||
|
|
path name in the NFS export entry list.</p>
|
||
|
|
|
||
|
|
<p>There is no implied order to the export entries that are returned. While no
|
||
|
|
sorting or sequencing has been done on the returned entries, a complete list
|
||
|
|
will eventually be returned if the *HANDLE option is used.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Object path name</em></dt>
|
||
|
|
|
||
|
|
<dd>The NFS export entry for the specified object path name is returned.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt>Length of object path name</dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the object path name in bytes. If one of the special values is
|
||
|
|
given for the object path name, then the length should be given for that
|
||
|
|
special value.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt>CCSID of object path name given</dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The CCSID of the object path name given as an input parameter. Possible
|
||
|
|
values follow:</p>
|
||
|
|
|
||
|
|
<dl compact>
|
||
|
|
<dt><em>0</em></dt>
|
||
|
|
|
||
|
|
<dd>The current Default Job CCSID should be used.</dd>
|
||
|
|
|
||
|
|
<dt><em>value</em></dt>
|
||
|
|
|
||
|
|
<dd>A valid CCSID number.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt>Desired CCSID of object the path names returned.</dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The Desired CCSID of the object path names returned. The output structure
|
||
|
|
will contain the actual CCSID of the returned object path names. This will
|
||
|
|
match the Desired CCSID given as input, if possible. Possible values
|
||
|
|
follow:</p>
|
||
|
|
|
||
|
|
<dl compact>
|
||
|
|
<dt><em>0</em></dt>
|
||
|
|
|
||
|
|
<dd>The current Default Job CCSID should be used.</dd>
|
||
|
|
|
||
|
|
<dt><em>value</em></dt>
|
||
|
|
|
||
|
|
<dd>A valid CCSID number.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt>Handle of starting object path name</dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The handle returned from a previous call to the QZNFRTVE API.</p>
|
||
|
|
|
||
|
|
<p>This parameter should be 0 if *HANDLE was NOT specified for the object path
|
||
|
|
name parameter.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt>Error code</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>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Receiver Variable Description</h3>
|
||
|
|
|
||
|
|
<p>The following table describes the order and format of the data returned in
|
||
|
|
the receiver variable. For a detailed description of each field, see <a href=
|
||
|
|
"#HDRRTVEFD">Field Descriptions</a>.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3><a name="HDREXPE100">EXPE0100 and EXPE0200 format</a></h3>
|
||
|
|
|
||
|
|
<p>This structure is used to return NFS export information for a single object
|
||
|
|
path name for both the EXPE0100 and the EXPE0200 formats.</p>
|
||
|
|
|
||
|
|
<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 entry</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 object path name</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 object path 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">CCSID of object path name</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">Read-only flag</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">NOSUID flag</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">Displacement to read-write host names</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">28</td>
|
||
|
|
<td align="center" valign="top">1C</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of read-write host names</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">32</td>
|
||
|
|
<td align="center" valign="top">20</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Displacement to root host names</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">36</td>
|
||
|
|
<td align="center" valign="top">24</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of root host names</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">Displacement to access host names</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">44</td>
|
||
|
|
<td align="center" valign="top">2C</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of access host names</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">48</td>
|
||
|
|
<td align="center" valign="top">30</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Displacement to host options</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">52</td>
|
||
|
|
<td align="center" valign="top">34</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of host options</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">56</td>
|
||
|
|
<td align="center" valign="top">38</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Anonymous user ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">60</td>
|
||
|
|
<td align="center" valign="top">3C</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Anonymous User Profile</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">Object path name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" rowspan="3" colspan="2">These fields repeat for
|
||
|
|
each host name in the read-write access list.</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of host name entry</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of host name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Host name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" rowspan="3" colspan="2">These fields repeat for
|
||
|
|
each host name in the root access list.</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of host name entry</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of host name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Host name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" rowspan="3" colspan="2">These fields repeat for
|
||
|
|
each host name in the access list.</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of host name entry</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of host name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Host name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" rowspan="6" colspan="2">These fields repeat for
|
||
|
|
each host name in the host options list.</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of host name options entry</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Network data file CCSID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Network path name CCSID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Write mode flag</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of host name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Host name</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<h3>Returned Records Feedback Information Description</h3>
|
||
|
|
|
||
|
|
<p>The following table describes the order and format of the data returned in
|
||
|
|
the returned records feedback information parameter. For a detailed description
|
||
|
|
of each field, see <a href="#HDRRTVEFD">Field Descriptions</a>.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3><a name="HDRRRFINF">Format of Returned Records Feedback
|
||
|
|
Information</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%">Bytes returned</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">Bytes available</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">Number of NFS export entries</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">Handle</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<h3><a name="HDRRTVEFD">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Anonymous User ID.</strong> The user ID used as the effective user
|
||
|
|
ID for requests from unknown users. Hex value 0xFFFFFFFF (a value of -1 if this
|
||
|
|
were a signed integer) indicates requests from unknown users are not
|
||
|
|
allowed.</p>
|
||
|
|
|
||
|
|
<p><strong>Anonymous User Profile.</strong> This is the i5/OS User Profile
|
||
|
|
name that is associated with the Anonymous User ID returned. If the Anonymous
|
||
|
|
User ID has the special value of hex value 0xFFFFFFFF (a value of -1 if this
|
||
|
|
were a signed integer), then the Anonymous User Profile will be set to the
|
||
|
|
special value of *NONE.</p>
|
||
|
|
|
||
|
|
<p><strong>Bytes available.</strong> The number of bytes of data available to
|
||
|
|
be returned to the user in the receiver variable. If all data is returned,
|
||
|
|
bytes available is the same as the number of bytes returned. If the receiver
|
||
|
|
variable was not large enough to contain all of the data, this value is
|
||
|
|
estimated based on the total number of entries in the NFS export entry list
|
||
|
|
that could be returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Bytes returned.</strong> The number of bytes of data returned to the
|
||
|
|
user in the receiver variable.</p>
|
||
|
|
|
||
|
|
<p><strong>CCSID of object path name.</strong> The CCSID of the object path
|
||
|
|
name.</p>
|
||
|
|
|
||
|
|
<p><strong>Object path name.</strong> The path name of the object for which
|
||
|
|
export information is to be returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Displacement to access host names.</strong> The offset (in bytes)
|
||
|
|
from the beginning of the NFS export entry to the host names in the access
|
||
|
|
list.</p>
|
||
|
|
|
||
|
|
<p><strong>Displacement to host options.</strong> The offset (in bytes) from
|
||
|
|
the beginning of the NFS export entry to the host options list.</p>
|
||
|
|
|
||
|
|
<p><strong>Displacement to object path name.</strong> The offset (in bytes)
|
||
|
|
from the beginning of the NFS export entry to the object path name.</p>
|
||
|
|
|
||
|
|
<p><strong>Displacement to read-write host names.</strong> The offset (in
|
||
|
|
bytes) from the beginning of the NFS export entry to the host names in the
|
||
|
|
read-write access list.</p>
|
||
|
|
|
||
|
|
<p><strong>Displacement to root host names.</strong> The offset (in bytes) from
|
||
|
|
the beginning of the NFS export entry to the host names in the root access
|
||
|
|
list.</p>
|
||
|
|
|
||
|
|
<p><strong>Handle.</strong> The handle to be used on a subsequent call to the
|
||
|
|
API to continue retrieving NFS export entries with the next object path name in
|
||
|
|
the NFS export entry list. 0 indicates all remaining NFS export entries have
|
||
|
|
been returned.</p>
|
||
|
|
|
||
|
|
<p><strong>Host name.</strong> The host name.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of entry.</strong> The length (in bytes) of the current NFS
|
||
|
|
export entry. The length can be used to access the next entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of host name.</strong> The length (in bytes) of the host
|
||
|
|
name.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of host name entry.</strong> The length (in bytes) of this
|
||
|
|
host name entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of host name options entry.</strong> The length (in bytes) of
|
||
|
|
this host name options entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of object path name.</strong> The length (in bytes) of the
|
||
|
|
object path name.</p>
|
||
|
|
|
||
|
|
<p><strong>Network data file CCSID.</strong> The CCSID used for data of the
|
||
|
|
files sent to and received from the specified host name.</p>
|
||
|
|
|
||
|
|
<p><strong>Network path name CCSID.</strong> The CCSID used for path name
|
||
|
|
components of the files sent to and received from the specified host name.</p>
|
||
|
|
|
||
|
|
<p><strong>NOSUID flag.</strong> Whether an attempt by the client to enable
|
||
|
|
bits other than the permission bits will be ignored. Possible values
|
||
|
|
follow:</p>
|
||
|
|
|
||
|
|
<dl compact>
|
||
|
|
<dt><em>0</em></dt>
|
||
|
|
|
||
|
|
<dd>An attempt to set bits other than the permission bits will be carried
|
||
|
|
out.</dd>
|
||
|
|
|
||
|
|
<dt><em>1</em></dt>
|
||
|
|
|
||
|
|
<dd>An attempt to set bits other than the permission bits will be ignored.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p><strong>Number of access host names.</strong> The number of host names in
|
||
|
|
the access list.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of host options.</strong> The number of entries in the host
|
||
|
|
options list.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of NFS export entries.</strong> The number of complete
|
||
|
|
entries returned in the list of NFS export entries. A value of zero is returned
|
||
|
|
if the list is empty relative to the requested starting position.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of read-write host names.</strong> The number of host names
|
||
|
|
in the read-write access list.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of root host names.</strong> The number of host names in the
|
||
|
|
root access list.</p>
|
||
|
|
|
||
|
|
<p><strong>Read-only flag.</strong> Whether the object is exported allowing
|
||
|
|
only read access. Possible values follow:</p>
|
||
|
|
|
||
|
|
<dl compact>
|
||
|
|
<dt><em>0</em></dt>
|
||
|
|
|
||
|
|
<dd>The object is exported allowing read-write access for all client hosts that
|
||
|
|
are not specifically indicated to have read-only access.</dd>
|
||
|
|
|
||
|
|
<dt><em>1</em></dt>
|
||
|
|
|
||
|
|
<dd>The object is exported allowing read-only access for all client hosts that
|
||
|
|
are not specifically indicated to have read-write access.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p><strong>Write mode flag.</strong> Whether write requests are handled
|
||
|
|
synchronously or asynchronously. Synchronously means that data will be written
|
||
|
|
to disk immediately. Asynchronously does not guarantee that data is written to
|
||
|
|
disk immediately, and can be used to improve server performance. Possible
|
||
|
|
values follow:</p>
|
||
|
|
|
||
|
|
<dl compact>
|
||
|
|
<dt><em>0</em></dt>
|
||
|
|
|
||
|
|
<dd>Write requests are performed synchronously.</dd>
|
||
|
|
|
||
|
|
<dt><em>1</em></dt>
|
||
|
|
|
||
|
|
<dd>Write requests are performed asynchronously.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<p>The following messages may be sent from this function:</p>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPE3418 E</td>
|
||
|
|
<td width="85%" valign="top">Possible APAR condition or hardware failure.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFA0D4 E</td>
|
||
|
|
<td valign="top">File system error occurred. Error number &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF2 E</td>
|
||
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C90 E</td>
|
||
|
|
<td valign="top">Literal value cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872 E</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
||
|
|
Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V4R3
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|