1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)directory.3 8.1 (Berkeley) 6/4/93
45 .Nd directory operations
52 .Fn opendir "const char *filename"
54 .Fn fdopendir "int fd"
56 .Fn readdir "DIR *dirp"
58 .Fn readdir_r "DIR *dirp" "struct dirent *entry" "struct dirent **result"
60 .Fn telldir "DIR *dirp"
62 .Fn seekdir "DIR *dirp" "long loc"
64 .Fn rewinddir "DIR *dirp"
66 .Fn closedir "DIR *dirp"
68 .Fn fdclosedir "DIR *dirp"
75 opens the directory named by
81 returns a pointer to be used to identify the
83 in subsequent operations.
88 cannot be accessed, or if it cannot
90 enough memory to hold the whole thing.
94 function is equivalent to the
96 function except that the directory is specified by a file descriptor
98 rather than by a name.
99 The file offset associated with the file descriptor at the time of the call
100 determines which entries are returned.
102 Upon successful return from
104 the file descriptor is under the control of the system,
105 and if any attempt is made to close the file descriptor,
106 or to modify the state of the associated description other than by means
113 the behavior is undefined.
116 the file descriptor is closed.
119 flag is set on the file descriptor by a successful call to
125 returns a pointer to the next directory entry.
128 upon reaching the end of the directory or on error.
129 In the event of an error,
131 may be set to any of the values documented for the
138 provides the same functionality as
140 but the caller must provide a directory
142 buffer to store the results in.
143 If the read succeeds,
147 upon reaching the end of the directory
154 returns 0 on success or an error number to indicate failure.
159 returns a token representing the current location associated with the named
160 .Em directory stream .
163 are good only for the lifetime of the
167 from which they are derived.
168 If the directory is closed and then
169 reopened, prior values returned by
171 will no longer be valid.
176 sets the position of the next
179 .Em directory stream .
180 The new position reverts to the one associated with the
184 operation was performed.
185 State associated with the token returned by
186 .Fn telldir is freed when it is passed to
188 If you wish return to the same location again,
189 then you must create a new token with another
196 resets the position of the named
198 to the beginning of the directory.
205 and frees the structure associated with the
208 returning 0 on success.
209 On failure, \-1 is returned and the global variable
211 is set to indicate the error.
215 function is equivalent to the
217 function except that this function returns directory file descriptor instead of
223 returns the integer file descriptor associated with the named
224 .Em directory stream ,
228 Sample code which searches a directory for entry ``name'' is:
229 .Bd -literal -offset indent
234 while ((dp = readdir(dirp)) != NULL) {
235 if (dp->d_namlen == len && strcmp(dp->d_name, name) == 0) {
236 (void)closedir(dirp);
240 (void)closedir(dirp);
259 functions appeared in