Differences between current version and revision by previous author of getdents(2).
Other diffs: Previous Major Revision, Previous Revision, or view the Annotated Edit History
| Newer page: | version 3 | Last edited on Monday, December 30, 2002 3:14:55 am | by PerryLorier | |
| Older page: | version 1 | Last edited on Tuesday, June 4, 2002 12:23:41 am | by perry | Revert |
@@ -1,98 +1,44 @@
-GETDENTS
-!!!GETDENTS
-NAME
-SYNOPSIS
-DESCRIPTION
-RETURN VALUE
-ERRORS
-CONFORMING TO
-SEE ALSO
-----
!!NAME
getdents - get directory entries
!!SYNOPSIS
+ __#include <unistd.h>__
+ __#include <linux/types.h>__
+ __#include <linux/dirent.h>__
+ __#include <linux/unistd.h>__
+ __int getdents(unsigned int__ fd, __struct dirent *__ dirp, __unsigned int__ count __);__
-__#include
-__ ''fd''__, struct dirent *__''dirp''__, unsigned int__ ''count''__);
-__
!!DESCRIPTION
+getdents(2) reads several ''dirent'' structures from the directory pointed at by ''fd'' into the memory area pointed to by ''dirp''. The parameter ''count'' is the size of the memory area.
+The ''dirent'' structure is declared as follows:
+ struct dirent
+ {
+ long d_ino; /* inode number */
+ off_t d_off; /* offset to next ''dirent'' */
+ unsigned short d_reclen; /* length of this ''dirent'' */
+ char d_name [[NAME_MAX+1]; /* file name (null-terminated) */
+ }
-__getdents__ reads several
''dirent
'' structures from
-the directory pointed at by
''fd
'' into
the memory area
-pointed
to by
''dirp
''. The parameter
''count
'' is the
-the memory area
.
+''d_ino
'' is an inode number.
''d_off
'' is
the distance from the start of the directory
to the start of the next
''dirent
''. ''d_reclen
'' is the size of this entire ''dirent. d_name'' is a null-terminated file name
.
+This call supersedes readdir(2).
-The ''dirent'' structure is declared as
-follows:
-
-
-struct dirent
-{
-long d_ino; /* inode number */
-off_t d_off; /* offset to next ''dirent'' */
-unsigned short d_reclen; /* length of this ''dirent'' */
-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 the start of the
-next ''dirent''. ''d_reclen'' is the size of this
-entire ''dirent. d_name'' is a null-terminated file
-name.
-
-
-This call supersedes readdir(2).
!!RETURN VALUE
+On success, the number of bytes read is returned. On end of directory, 0 is returned. On error, -1 is returned, and ''errno'' is set appropriately.
-On success, the number of bytes read 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
+SVr4, SVID. SVr4 documents additional [ENOLINK], [EIO] error conditions.
-
-SVr4, SVID. SVr4 documents additional ENOLINK, EIO error
-conditions.
!!SEE ALSO
-
-
readdir(2), readdir(3)
-----
