1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
.\" 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)
.\"
.TH READDIR 3 1996-04-22 "" "Linux Programmer's Manual"
.SH NAME
readdir \- read a directory
.SH SYNOPSIS
.nf
.B #include <sys/types.h>
.sp
.B #include <dirent.h>
.sp
.BI "struct dirent *readdir(DIR *" dir );
.fi
.SH DESCRIPTION
The \fBreaddir\fP() function returns a pointer to a \fIdirent\fP structure
representing the next directory entry in the directory stream pointed
to by \fIdir\fP.
It returns NULL on reaching the end-of-file or if
an error occurred.
.PP
On Linux, the
.I dirent
structure is defined as follows:
.PP
.RS 0.25i
.nf
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 */
};
.fi
.RE
.PP
According to POSIX, the
.I dirent
structure contains a field
.I "char d_name[]"
of unspecified size, with at most
.B NAME_MAX
characters preceding the terminating null byte.
POSIX.1-2001 also documents the field
.I "ino_t d_ino"
as an XSI extension.
.IR "Use of other fields will harm the portability of your programs" .
.PP
The data returned by \fBreaddir\fP() may be overwritten by subsequent
calls to \fBreaddir\fP() for the same directory stream.
.SH "RETURN VALUE"
The \fBreaddir\fP() function returns a pointer to a
.I dirent
structure, or
NULL if an error occurs or end-of-file is reached.
On error,
.I errno
is set appropriately.
.SH ERRORS
.TP
.B EBADF
Invalid directory stream descriptor \fIdir\fP.
.SH "CONFORMING TO"
SVr4, 4.3BSD, POSIX.1-2001
.SH "SEE ALSO"
.BR read (2),
.BR closedir (3),
.BR dirfd (3),
.BR ftw (3),
.BR opendir (3),
.BR rewinddir (3),
.BR scandir (3),
.BR seekdir (3),
.BR telldir (3)
|
