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
29 .\" $FreeBSD: src/lib/libc/gen/directory.3,v 1.7.2.5 2003/03/15 15:11:05 trhodes Exp $
30 .\" $DragonFly: src/lib/libc/gen/directory.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
45 .Nd directory operations
52 .Fn fdopendir "int fd"
54 .Fn opendir "const char *filename"
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"
73 opens the directory named by
79 returns a pointer to be used to identify the
81 in subsequent operations. The pointer
85 cannot be accessed, or if it cannot
87 enough memory to hold the whole thing.
93 with the directory file descriptor
95 The file offset associated with
97 at the time of the call determines which entries are returned.
98 The file descriptor must not be used further by the caller in any way.
103 returns a pointer to the next directory entry. It returns
105 upon reaching the end of the directory or detecting an invalid
112 provides the same functionality as
114 but the caller must provide a directory
116 buffer to store the results in. If the read succeeds,
120 upon reaching the end of the directory
127 returns 0 on success or an error number to indicate failure.
132 returns the current location associated with the named
133 .Em directory stream .
136 are good only for the lifetime of the
140 from which they are derived. If the directory is closed and then
141 reopened, prior values returned by
143 will no longer be valid.
148 sets the position of the next
151 .Em directory stream .
152 The new position reverts to the one associated with the
156 operation was performed.
161 resets the position of the named
163 to the beginning of the directory.
170 and frees the structure associated with the
173 returning 0 on success.
174 On failure, \-1 is returned and the global variable
176 is set to indicate the error.
181 returns the integer file descriptor associated with the named
182 .Em directory stream ,
186 Sample code which searches a directory for entry ``name'' is:
187 .Bd -literal -offset indent
190 while ((dp = readdir(dirp)) != NULL)
191 if (dp->d_namlen == len && !strcmp(dp->d_name, name)) {
192 (void)closedir(dirp);
195 (void)closedir(dirp);
214 functions appeared in