diff options
Diffstat (limited to 'static/freebsd/man9/VOP_READDIR.9 4.html')
| -rw-r--r-- | static/freebsd/man9/VOP_READDIR.9 4.html | 109 |
1 files changed, 0 insertions, 109 deletions
diff --git a/static/freebsd/man9/VOP_READDIR.9 4.html b/static/freebsd/man9/VOP_READDIR.9 4.html deleted file mode 100644 index 705579f4..00000000 --- a/static/freebsd/man9/VOP_READDIR.9 4.html +++ /dev/null @@ -1,109 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">VOP_READDIR(9)</td> - <td class="head-vol">Kernel Developer's Manual</td> - <td class="head-rtitle">VOP_READDIR(9)</td> - </tr> -</table> -<div class="manual-text"> -<section class="Sh"> -<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<p class="Pp"><code class="Nm">VOP_READDIR</code> — <span class="Nd">read - contents of a directory</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp"><code class="In">#include - <<a class="In">sys/param.h</a>></code> - <br/> - <code class="In">#include <<a class="In">sys/dirent.h</a>></code> - <br/> - <code class="In">#include <<a class="In">sys/vnode.h</a>></code></p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">VOP_READDIR</code>(<var class="Fa" style="white-space: nowrap;">struct - vnode *vp</var>, <var class="Fa" style="white-space: nowrap;">struct uio - *uio</var>, <var class="Fa" style="white-space: nowrap;">struct ucred - *cred</var>, <var class="Fa" style="white-space: nowrap;">int - *eofflag</var>, <var class="Fa" style="white-space: nowrap;">int - *ncookies</var>, <var class="Fa" style="white-space: nowrap;">uint64_t - **cookies</var>);</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">Read directory entries.</p> -<dl class="Bl-tag"> - <dt><var class="Fa">vp</var></dt> - <dd>The vnode of the directory.</dd> - <dt><var class="Fa">uio</var></dt> - <dd>Where to read the directory contents.</dd> - <dt><var class="Fa">cred</var></dt> - <dd>The caller's credentials.</dd> - <dt><var class="Fa">eofflag</var></dt> - <dd>Return end of file status (<code class="Dv">NULL</code> if not - wanted).</dd> - <dt><var class="Fa">ncookies</var></dt> - <dd>Number of directory cookies generated for NFS - (<code class="Dv">NULL</code> if not wanted).</dd> - <dt><var class="Fa">cookies</var></dt> - <dd>Directory seek cookies generated for NFS (<code class="Dv">NULL</code> if - not wanted).</dd> -</dl> -The directory contents are read into <var class="Vt">struct dirent</var> - structures. If the on-disc data structures differ from this then they should - be translated. -</section> -<section class="Sh"> -<h1 class="Sh" id="LOCKS"><a class="permalink" href="#LOCKS">LOCKS</a></h1> -<p class="Pp">The directory should be locked on entry and will still be locked - on exit.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN - VALUES</a></h1> -<p class="Pp">Zero is returned on success, otherwise an error code is - returned.</p> -<p class="Pp">If this is called from the NFS server, the extra arguments - <var class="Fa">eofflag</var>, <var class="Fa">ncookies</var> and - <var class="Fa">cookies</var> are given. The value of - <var class="Fa">*eofflag</var> should be set to TRUE if the end of the - directory is reached while reading. The directory seek cookies are returned - to the NFS client and may be used later to restart a directory read part way - through the directory. There should be one cookie returned per directory - entry. The value of the cookie should be the offset within the directory - where the on-disc version of the appropriate directory entry starts. Memory - for the cookies should be allocated using:</p> -<div class="Bd Pp Li"> -<pre> ...; - *ncookies = number of entries read; - *cookies = malloc(*ncookies * sizeof(**cookies), M_TEMP, M_WAITOK);</pre> -</div> -</section> -<section class="Sh"> -<h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1> -<dl class="Bl-tag"> - <dt id="EINVAL">[<a class="permalink" href="#EINVAL"><code class="Er">EINVAL</code></a>]</dt> - <dd>An attempt was made to read from an illegal offset in the directory.</dd> - <dt id="EIO">[<a class="permalink" href="#EIO"><code class="Er">EIO</code></a>]</dt> - <dd>A read error occurred while reading the directory.</dd> - <dt id="EINTEGRITY">[<a class="permalink" href="#EINTEGRITY"><code class="Er">EINTEGRITY</code></a>]</dt> - <dd>Corrupted data was detected while reading the directory.</dd> -</dl> -</section> -<section class="Sh"> -<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE - ALSO</a></h1> -<p class="Pp"><a class="Xr">vnode(9)</a></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> -<p class="Pp">This manual page was written by <span class="An">Doug - Rabson</span>.</p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">December 13, 2021</td> - <td class="foot-os">FreeBSD 15.0</td> - </tr> -</table> |