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
43 .Nd directory operations
50 .Fn opendir "const char *filename"
52 .Fn readdir "DIR *dirp"
54 .Fn readdir_r "DIR *dirp" "struct dirent *entry" "struct dirent **result"
56 .Fn telldir "DIR *dirp"
58 .Fn seekdir "DIR *dirp" "long loc"
60 .Fn rewinddir "DIR *dirp"
62 .Fn closedir "DIR *dirp"
69 opens the directory named by
75 returns a pointer to be used to identify the
77 in subsequent operations.
82 cannot be accessed, or if it cannot
84 enough memory to hold the whole thing.
89 returns a pointer to the next directory entry.
92 upon reaching the end of the directory or detecting an invalid
99 provides the same functionality as
101 but the caller must provide a directory
103 buffer to store the results in.
104 If the read succeeds,
108 upon reaching the end of the directory
115 returns 0 on success or an error number to indicate failure.
120 returns the current location associated with the named
121 .Em directory stream .
124 are good only for the lifetime of the
128 from which they are derived.
129 If the directory is closed and then
130 reopened, prior values returned by
132 will no longer be valid.
137 sets the position of the next
140 .Em directory stream .
141 The new position reverts to the one associated with the
145 operation was performed.
150 resets the position of the named
152 to the beginning of the directory.
159 and frees the structure associated with the
162 returning 0 on success.
163 On failure, \-1 is returned and the global variable
165 is set to indicate the error.
170 returns the integer file descriptor associated with the named
171 .Em directory stream ,
175 Sample code which searches a directory for entry ``name'' is:
176 .Bd -literal -offset indent
179 while ((dp = readdir(dirp)) != NULL)
180 if (dp->d_namlen == len && !strcmp(dp->d_name, name)) {
181 (void)closedir(dirp);
184 (void)closedir(dirp);
203 functions appeared in