GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  VOP_READDIR (9)

NAME

VOP_READDIR - read contents of a directory

CONTENTS

Synopsis
Description
Locks
Return Values
Errors
See Also
Authors

SYNOPSIS


.In sys/param.h
.In sys/dirent.h
.In sys/vnode.h int VOP_READDIR struct vnode *vp struct uio *uio struct ucred *cred int *eofflag int *ncookies u_long **cookies

DESCRIPTION

Read directory entries.
vp The vnode of the directory.
uio Where to read the directory contents.
cred The caller’s credentials.
eofflag Return end of file status ( NULL if not wanted).
ncookies
  Number of directory cookies generated for NFS ( NULL if not wanted).
cookies Directory seek cookies generated for NFS ( NULL if not wanted).
The directory contents are read into
.Vt struct dirent structures. If the on-disc data structures differ from this then they should be translated.

LOCKS

The directory should be locked on entry and will still be locked on exit.

RETURN VALUES

Zero is returned on success, otherwise an error code is returned.

If this is called from the NFS server, the extra arguments eofflag, ncookies and cookies are given. The value of *eofflag 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:

        ...;
        *ncookies = number of entries read;
        *cookies = malloc(*ncookies * sizeof(u_long), M_TEMP, M_WAITOK);

ERRORS

[EINVAL]
  An attempt was made to read from an illegal offset in the directory.
[EIO] A read error occurred while reading the directory.

SEE ALSO

vnode(9)

AUTHORS

This manual page was written by
.An Doug Rabson .
Search for    or go to Top of page |  Section 9 |  Main Index


Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.