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
44 .Nd directory operations
51 .Fn opendir "const char *filename"
53 .Fn fdopendir "int fd"
55 .Fn readdir "DIR *dirp"
57 .Fn readdir_r "DIR *dirp" "struct dirent *entry" "struct dirent **result"
59 .Fn telldir "DIR *dirp"
61 .Fn seekdir "DIR *dirp" "long loc"
63 .Fn rewinddir "DIR *dirp"
65 .Fn closedir "DIR *dirp"
72 opens the directory named by
78 returns a pointer to be used to identify the
80 in subsequent operations.
85 cannot be accessed, or if it cannot
87 enough memory to hold the whole thing.
91 function is equivalent to the
93 function except that the directory is specified by a file descriptor
95 rather than by a name.
96 The file offset associated with the file descriptor at the time of the call
97 determines which entries are returned.
99 Upon successful return from
101 the file descriptor is under the control of the system,
102 and if any attempt is made to close the file descriptor,
103 or to modify the state of the associated description other than by means
110 the behavior is undefined.
113 the file descriptor is closed.
116 flag is set on the file descriptor by a successful call to
122 returns a pointer to the next directory entry.
125 upon reaching the end of the directory or on error.
126 In the event of an error,
128 may be set to any of the values documented for the
135 provides the same functionality as
137 but the caller must provide a directory
139 buffer to store the results in.
140 If the read succeeds,
144 upon reaching the end of the directory
151 returns 0 on success or an error number to indicate failure.
156 returns the current location associated with the named
157 .Em directory stream .
160 are good only for the lifetime of the
164 from which they are derived.
165 If the directory is closed and then
166 reopened, prior values returned by
168 will no longer be valid.
173 sets the position of the next
176 .Em directory stream .
177 The new position reverts to the one associated with the
181 operation was performed.
186 resets the position of the named
188 to the beginning of the directory.
195 and frees the structure associated with the
198 returning 0 on success.
199 On failure, \-1 is returned and the global variable
201 is set to indicate the error.
206 returns the integer file descriptor associated with the named
207 .Em directory stream ,
211 Sample code which searches a directory for entry ``name'' is:
212 .Bd -literal -offset indent
217 while ((dp = readdir(dirp)) != NULL) {
218 if (dp->d_namlen == len && strcmp(dp->d_name, name) == 0) {
219 (void)closedir(dirp);
223 (void)closedir(dirp);
242 functions appeared in