8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3c / readdir.3c
blobb0198adca2ce2bd13d811b67ef41faa745479673
1 '\" te
2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
7 .\"  This notice shall appear on any product containing this material.
8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
11 .TH READDIR 3C "Jun 26, 2007"
12 .SH NAME
13 readdir, readdir_r \- read directory
14 .SH SYNOPSIS
15 .LP
16 .nf
17 #include <sys/types.h>
18 #include <dirent.h>
20 \fBstruct dirent *\fR\fBreaddir\fR(\fBDIR *\fR\fIdirp\fR);
21 .fi
23 .LP
24 .nf
25 \fBstruct dirent *\fR\fBreaddir_r\fR(\fBDIR *\fR\fIdirp\fR, \fBstruct dirent *\fR\fIentry\fR);
26 .fi
28 .SS "Standard conforming"
29 .LP
30 .nf
31 cc [ \fIflag\fR... ] \fIfile\fR... \fB-D_POSIX_PTHREAD_SEMANTICS\fR [ \fIlibrary\fR... ]
33 \fBint\fR \fBreaddir_r\fR(\fBDIR *restrict\fR \fIdirp\fR, \fBstruct dirent *restrict\fR \fIentry\fR,
34      \fBstruct dirent **restrict\fR \fIresult\fR);
35 .fi
37 .SH DESCRIPTION
38 .sp
39 .LP
40 The type \fBDIR\fR, which is defined in the header <\fBdirent.h\fR>, represents
41 a \fIdirectory stream\fR, which is an ordered sequence of all the directory
42 entries in a particular directory. Directory entries represent files. Files can
43 be removed from a directory or added to a directory asynchronously to the
44 operation of \fBreaddir()\fR and \fBreaddir_r()\fR.
45 .SS "\fBreaddir()\fR"
46 .sp
47 .LP
48 The \fBreaddir()\fR function returns a pointer to a structure representing the
49 directory entry at the current position in the directory stream specified by
50 the argument \fIdirp\fR, and positions the directory stream at the next entry.
51 It returns a null pointer upon reaching the end of the directory stream. The
52 structure \fBdirent\fR defined by the \fB<dirent.h>\fR header describes a
53 directory entry.
54 .sp
55 .LP
56 The \fBreaddir()\fR function will not return directory entries containing empty
57 names. If entries for . (dot) or .. (dot-dot) exist, one entry will be returned
58 for dot and one entry will be returned for dot-dot; otherwise they will not be
59 returned.
60 .sp
61 .LP
62 The pointer returned by \fBreaddir()\fR points to data that can be overwritten
63 by another call to \fBreaddir()\fR on the same directory stream. These data are
64 not overwritten by another call to \fBreaddir()\fR on a different directory
65 stream.
66 .sp
67 .LP
68 If a file is removed from or added to the directory after the most recent call
69 to \fBopendir\fR(3C) or \fBrewinddir\fR(3C), whether a subsequent call to
70 \fBreaddir()\fR returns an entry for that file is unspecified.
71 .sp
72 .LP
73 The \fBreaddir()\fR function can buffer several directory entries per actual
74 read operation. It marks for update the \fBst_atime\fR field of the directory
75 each time the directory is actually read.
76 .sp
77 .LP
78 After a call to \fBfork\fR(2), either the parent or child (but not both) can
79 continue processing the directory stream using \fBreaddir()\fR,
80 \fBrewinddir()\fR or \fBseekdir\fR(3C). If both the parent and child processes
81 use these functions, the result is undefined.
82 .sp
83 .LP
84 If the entry names a symbolic link, the value of the \fBd_ino\fR member is
85 unspecified.
86 .SS "\fBreaddir_r()\fR"
87 .sp
88 .LP
89 Unless the end of the directory stream has been reached or an error occurred,
90 the \fBreaddir_r()\fR function initializes the \fBdirent\fR structure
91 referenced by \fBentry\fR to represent the directory entry at the current
92 position in the directory stream referred to by \fIdirp\fR,  and positions the
93 directory stream at the next entry.
94 .sp
95 .LP
96 The caller must allocate storage pointed to by \fIentry\fR to be large enough
97 for a \fBdirent\fR structure with an array of \fBchar\fR \fBd_name\fR member
98 containing at least \fBNAME_MAX\fR (that is, \fBpathconf(directory,
99 _PC_NAME_MAX\fR)) plus one elements. (\fB_PC_NAME_MAX\fR is defined in
100 <\fBunistd.h\fR>.)
103 The \fBreaddir_r()\fR function will not return directory entries containing
104 empty names. It is unspecified whether entries are returned for . (dot) or ..
105 (dot-dot).
108 If a file is removed from or added to the directory after the most recent call
109 to \fBopendir()\fR or \fBrewinddir()\fR, whether a subsequent call to
110 \fBreaddir_r()\fR returns an entry for that file is unspecified.
113 The \fBreaddir_r()\fR function can buffer several directory entries per actual
114 read operation. It marks for update the \fBst_atime\fR field of the directory
115 each time the directory is actually read.
118 The standard-conforming version (see \fBstandards\fR(5)) of the
119 \fBreaddir_r()\fR function performs all of the actions described above and sets
120 the pointer pointed to by \fIresult\fR. If a directory entry is returned, the
121 pointer will be set to the same value as the \fIentry\fR argument; otherwise,
122 it will be set to \fINULL\fR.
123 .SH RETURN VALUES
126 Upon successful completion, \fBreaddir()\fR and the default \fBreaddir_r()\fR
127 return a pointer to an object of type \fBstruct dirent\fR. When an error is
128 encountered, a null pointer is returned and \fBerrno\fR is set to indicate the
129 error. When the end of the directory is encountered, a null pointer is returned
130 and \fBerrno\fR is not changed.
133 The standard-conforming \fBreaddir_r()\fR returns  \fB0\fR if the end of the
134 directory is encountered or a directory entry is stored in the structure
135 referenced by \fIentry\fR. Otherwise, an error number is returned to indicate
136 the failure.
137 .SH ERRORS
140 The \fBreaddir()\fR and \fBreaddir_r()\fR functions will fail if:
142 .ne 2
144 \fB\fBEOVERFLOW\fR\fR
146 .RS 13n
147 One of the values in the structure to be returned cannot be represented
148 correctly.
153 The \fBreaddir()\fR and \fBreaddir_r()\fR functions may fail if:
155 .ne 2
157 \fB\fBEBADF\fR\fR
159 .RS 10n
160 The \fIdirp\fR argument does not refer to an open directory stream.
164 .ne 2
166 \fB\fBENOENT\fR\fR
168 .RS 10n
169 The current position of the directory stream is invalid.
172 .SH USAGE
175 The \fBreaddir()\fR  and \fBreaddir_r()\fR functions should be used in
176 conjunction with \fBopendir()\fR, \fBclosedir()\fR, and \fBrewinddir()\fR to
177 examine the contents of the directory.  Since \fBreaddir()\fR and the default
178 \fBreaddir_r()\fR return a null pointer both at the end of the directory and on
179 error, an application wanting to check for error situations should set
180 \fBerrno\fR to 0 before calling either of these functions. If \fBerrno\fR is
181 set to non-zero on return, an error occurred.
184 It is safe to use \fBreaddir()\fR in a threaded application, so long as only
185 one thread reads from the directory stream at any given time. The
186 \fBreaddir()\fR function is generally preferred over the \fBreaddir_r()\fR
187 function.
190 The standard-conforming \fBreaddir_r()\fR returns the error number if an error
191 occurred. It returns 0 on success (including reaching the end of the directory
192 stream).
195 The \fBreaddir()\fR and \fBreaddir_r()\fR functions have transitional
196 interfaces for 64-bit file offsets.  See \fBlf64\fR(5).
197 .SH EXAMPLES
199 \fBExample 1 \fRSearch the current directory for the entry \fIname\fR.
202 The following sample program will search the current directory for each of the
203 arguments supplied on the command line:
206 .in +2
208 #include <sys/types.h>
209 #include <dirent.h>
210 #include <errno.h>
211 #include <stdio.h>
212 #include <strings.h>
214 static void lookup(const char *arg)
216         DIR *dirp;
217         struct dirent *dp;
219         if ((dirp = opendir(".")) == NULL) {
220                 perror("couldn't open '.'");
221                 return;
222         }
224         do {
225                 errno = 0;
226                 if ((dp = readdir(dirp)) != NULL) {
227                         if (strcmp(dp->d_name, arg) != 0)
228                                 continue;
230                         (void) printf("found %s\en", arg);
231                         (void) closedir(dirp);
232                         return;
233                 }
234         } while (dp != NULL);
236         if (errno != 0)
237                 perror("error reading directory");
238         else
239                 (void) printf("failed to find %s\en", arg);
240         (void) closedir(dirp);
241         return;
244 int main(int argc, char *argv[])
246         int i;
247         for (i = 1; i < argc; i++)
248                 lookup(argv[i]);
249         return (0);
252 .in -2
254 .SH ATTRIBUTES
257 See \fBattributes\fR(5) for descriptions of the following attributes:
262 box;
263 c | c
264 l | l .
265 ATTRIBUTE TYPE  ATTRIBUTE VALUE
267 Interface Stability     Standard
269 MT-Level        See below.
274 The \fBreaddir()\fR function is Unsafe. The \fBreaddir_r()\fR function is Safe.
275 .SH SEE ALSO
278 \fBfork\fR(2), \fBlstat\fR(2), \fBsymlink\fR(2), \fBIntro\fR(3),
279 \fBclosedir\fR(3C), \fBopendir\fR(3C), \fBrewinddir\fR(3C), \fBscandir\fR(3C),
280 \fBseekdir\fR(3C), \fBattributes\fR(5), \fBlf64\fR(5), \fBstandards\fR(5)
281 .SH NOTES
284 When compiling multithreaded programs, see the \fBMULTITHREADED APPLICATIONS\fR
285 section of \fBIntro\fR(3).
288 Solaris 2.4 and earlier releases provided a \fBreaddir_r()\fR interface as
289 specified in POSIX.1c Draft 6. The final POSIX.1c standard changed the
290 interface as described above. Support for the Draft 6 interface is provided for
291 compatibility only and might not be supported in future releases. New
292 applications and libraries should use the standard-conforming interface.
295 For POSIX.1c-conforming applications, the \fB_POSIX_PTHREAD_SEMANTICS\fR and
296 \fB_REENTRANT\fR flags are automatically turned on by defining the
297 \fB_POSIX_C_SOURCE\fR flag with a value >= 199506L.