Differences between current version and revision by previous author of readdir(2).
Other diffs: Previous Major Revision, Previous Revision, or view the Annotated Edit History
| Newer page: | version 2 | Last edited on Sunday, March 16, 2003 8:31:18 pm | by PerryLorier | |
| Older page: | version 1 | Last edited on Tuesday, June 4, 2002 12:23:44 am | by perry | Revert |
@@ -1,101 +1,42 @@
-READDIR
-!!!READDIR
-NAME
-SYNOPSIS
-DESCRIPTION
-RETURN VALUE
-ERRORS
-CONFORMING TO
-SEE ALSO
-----
!!NAME
+readdir - read directory entry
-
-readdir - read directory entry
!!SYNOPSIS
+ __#include <unistd.h>__
+ __#include <linux/dirent.h>__
+ __#include <linux/unistd.h>__
+ __int readdir(unsigned int__ ''fd''__, struct dirent *__''dirp''__, unsigned int__ ''count''__);__
-__#include
-__ ''fd''__, struct dirent *__''dirp''__, unsigned int__ ''count''__);
-__
!!DESCRIPTION
+This is not the function you are interested in. Look at readdir(3) for the [POSIX] conforming C library interface. This page documents the bare kernel system call interface, which can change, and which is superseded by getdents(2).
+__readdir__ reads one ''dirent'' structure from the directory pointed at by ''fd'' into the memory area pointed to by ''dirp''. The parameter ''count'' is ignored; at most one dirent structure is read.
-This
is not the function you are interested in. Look at
-readdir(3) for the POSIX conforming C library
-interface. This page documents the bare kernel system call
-interface, which can change, and which is superseded by
-getdents(2).
+The ''dirent'' structure
is declared as follows:
+ struct dirent
+ {
+ long d_ino; /* inode number */
+ off_t d_off; /* offset to this ''dirent'' */
+ unsigned short d_reclen; /* length of this ''d_name'' */
+ char d_name [[NAME_MAX+1]; /* file name (null-terminated) */
+ }
-__readdir__ reads one
''dirent
'' structure
from the
-pointed at by
''fd
'' into
the memory area
-pointed to by
''dirp
''. The parameter
''count
'' is
-ignored; at most one dirent structure is read
.
+''d
_ino
'' is an inode number.
''d_off'' is the distance
from the start of the
directory to this
''dirent
''. ''d_reclen'' is
the size of
''d_name,
'' not counting the null terminator
. ''d_name
'' is a null-terminated file name
.
-
-The ''dirent'' structure is declared as
-follows:
-
-
-struct dirent
-{
-long d_ino; /* inode number */
-off_t d_off; /* offset to this ''dirent'' */
-unsigned short d_reclen; /* length of this ''d_name'' */
-char d_name [[NAME_MAX+1]; /* file name (null-terminated) */
-}
-
-
-''d_ino'' is an inode number. ''d_off'' is the
-distance from the start of the directory to this
-''dirent''. ''d_reclen'' is the size of ''d_name,''
-not counting the null terminator. ''d_name'' is a
-null-terminated file name.
!!RETURN VALUE
+On success, 1 is returned. On end of directory, 0 is returned. On error, -1 is returned, and ''errno'' is set appropriately.
-
-On success, 1 is returned. On end of directory, 0 is
-returned. On error, -1 is returned, and ''errno'' is set
-appropriately.
!!ERRORS
+;[EBADF]: Invalid file descriptor ''fd''.
+;[EFAULT]: Argument points outside the calling process's address space.
+;[EINVAL]: Result buffer is too small.
+;[ENOENT]: No such directory.
+;[ENOTDIR]: File descriptor does not refer to a directory.
-
-__EBADF__
-
-
-Invalid file descriptor ''fd''.
-
-
-__EFAULT__
-
-
-Argument points outside the calling process's address
-space.
-
-
-__EINVAL__
-
-
-Result buffer is too small.
-
-
-__ENOENT__
-
-
-No such directory.
-
-
-__ENOTDIR__
-
-
-File descriptor does not refer to a directory.
!!CONFORMING TO
+This system call is Linux specific.
-
-This system call is Linux specific.
!!SEE ALSO
-
-
getdents(2), readdir(3)
-----
