readdir — read a directory
#include <sys/types.h> #include <dirent.h>
struct dirent *readdir( |
DIR * | dir) ; |
The readdir
() function
returns a pointer to a dirent
structure representing
the next directory entry in the directory stream pointed to
by dir
. It returns
NULL on reaching the end-of-file or if an error occurred.
On Linux, the dirent
structure is defined
as follows:
struct dirent { ino_t d_ino
; /* inode number */off_t d_off
; /* offset to the next dirent */unsigned short d_reclen
; /* length of this record */unsigned char d_type
; /* type of file */char d_name
[256]; /* filename */};
According to POSIX, the dirent
structure contains a
field char d_name[] of
unspecified size, with at most NAME_MAX
characters preceding the
terminating null byte. POSIX.1-2001 also documents the field
ino_t d_ino as an XSI
extension. Use of other fields
will harm the portability of your programs.
The data returned by readdir
() may be overwritten by subsequent
calls to readdir
() for the same
directory stream.
The readdir
() function
returns a pointer to a dirent
structure, or NULL if
an error occurs or end-of-file is reached. On error,
errno
is set appropriately.
read(2), closedir(3), dirfd(3), ftw(3), opendir(3), rewinddir(3), scandir(3), seekdir(3), telldir(3)
Copyright (C) 1993 David Metcalfe (david@prism.demon.co.uk) Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Since the Linux kernel and libraries are constantly changing, this manual page may be incorrect or out-of-date. The author(s) assume no responsibility for errors or omissions, or for damages resulting from the use of the information contained herein. The author(s) may not have taken the same level of care in the production of this manual, which is licensed free of charge, as they might when working professionally. Formatted or processed versions of this manual, if unaccompanied by the source, must acknowledge the copyright and authors of this work. References consulted: Linux libc source code Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) 386BSD man pages Modified Sat Jul 24 16:09:49 1993 by Rik Faith (faith@cs.unc.edu) Modified 11 June 1995 by Andries Brouwer (aeb@cwi.nl) Modified 22 July 1996 by Andries Brouwer (aeb@cwi.nl) |