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 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)directory.3 8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/lib/libc/gen/directory.3,v 1.7.2.5 2003/03/15 15:11:05 trhodes Exp $
34 .\" $DragonFly: src/lib/libcr/gen/Attic/directory.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
48 .Nd directory operations
55 .Fn opendir "const char *filename"
57 .Fn readdir "DIR *dirp"
59 .Fn readdir_r "DIR *dirp" "struct dirent *entry" "struct dirent **result"
61 .Fn telldir "DIR *dirp"
63 .Fn seekdir "DIR *dirp" "long loc"
65 .Fn rewinddir "DIR *dirp"
67 .Fn closedir "DIR *dirp"
74 opens the directory named by
80 returns a pointer to be used to identify the
82 in subsequent operations. The pointer
86 cannot be accessed, or if it cannot
88 enough memory to hold the whole thing.
93 returns a pointer to the next directory entry. It returns
95 upon reaching the end of the directory or detecting an invalid
102 provides the same functionality as
104 but the caller must provide a directory
106 buffer to store the results in. If the read succeeds,
110 upon reaching the end of the directory
117 returns 0 on success or an error number to indicate failure.
122 returns the current location associated with the named
123 .Em directory stream .
126 are good only for the lifetime of the
130 from which they are derived. If the directory is closed and then
131 reopened, prior values returned by
133 will no longer be valid.
138 sets the position of the next
141 .Em directory stream .
142 The new position reverts to the one associated with the
146 operation was performed.
151 resets the position of the named
153 to the beginning of the directory.
160 and frees the structure associated with the
163 returning 0 on success.
164 On failure, \-1 is returned and the global variable
166 is set to indicate the error.
171 returns the integer file descriptor associated with the named
172 .Em directory stream ,
176 Sample code which searches a directory for entry ``name'' is:
177 .Bd -literal -offset indent
180 while ((dp = readdir(dirp)) != NULL)
181 if (dp->d_namlen == len && !strcmp(dp->d_name, name)) {
182 (void)closedir(dirp);
185 (void)closedir(dirp);
204 functions appeared in