lib/libc/gen/directory.3

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  19 .\"
  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
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)directory.3 8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt DIRECTORY 3
  37 .Os
  38 .Sh NAME
  39 .Nm opendir ,
  40 .Nm readdir ,
  41 .Nm readdir_r ,
  42 .Nm telldir ,
  43 .Nm seekdir ,
  44 .Nm rewinddir ,
  45 .Nm closedir ,
  46 .Nm dirfd
  47 .Nd directory operations
  48 .Sh LIBRARY
  49 .Lb libc
  50 .Sh SYNOPSIS
  51 .In sys/types.h
  52 .In dirent.h
  53 .Ft DIR *
  54 .Fn opendir "const char *filename"
  55 .Ft struct dirent *
  56 .Fn readdir "DIR *dirp"
  57 .Ft int
  58 .Fn readdir_r "DIR *dirp" "struct dirent *entry" "struct dirent **result"
  59 .Ft long
  60 .Fn telldir "DIR *dirp"
  61 .Ft void
  62 .Fn seekdir "DIR *dirp" "long loc"
  63 .Ft void
  64 .Fn rewinddir "DIR *dirp"
  65 .Ft int
  66 .Fn closedir "DIR *dirp"
  67 .Ft int
  68 .Fn dirfd "DIR *dirp"
  69 .Sh DESCRIPTION
  70 The
  71 .Fn opendir
  72 function
  73 opens the directory named by
  74 .Fa filename ,
  75 associates a
  76 .Em directory stream
  77 with it
  78 and
  79 returns a pointer to be used to identify the
  80 .Em directory stream
  81 in subsequent operations.
  82 The pointer
  83 .Dv NULL
  84 is returned if
  85 .Fa filename
  86 cannot be accessed, or if it cannot
  87 .Xr malloc 3
  88 enough memory to hold the whole thing.
  89 .Pp
  90 The
  91 .Fn readdir
  92 function
  93 returns a pointer to the next directory entry.
  94 It returns
  95 .Dv NULL
  96 upon reaching the end of the directory or detecting an invalid
  97 .Fn seekdir
  98 operation.
  99 .Pp
 100 The
 101 .Fn readdir_r
 102 function
 103 provides the same functionality as
 104 .Fn readdir ,
 105 but the caller must provide a directory
 106 .Fa entry
 107 buffer to store the results in.
 108 If the read succeeds,
 109 .Fa result
 110 is pointed at the
 111 .Fa entry ;
 112 upon reaching the end of the directory
 113 .Fa result
 114 is set to
 115 .Dv NULL .
 116 The
 117 .Fn readdir_r
 118 function
 119 returns 0 on success or an error number to indicate failure.
 120 .Pp
 121 The
 122 .Fn telldir
 123 function
 124 returns the current location associated with the named
 125 .Em directory stream .
 126 Values returned by
 127 .Fn telldir
 128 are good only for the lifetime of the
 129 .Dv DIR
 130 pointer,
 131 .Fa dirp ,
 132 from which they are derived.
 133 If the directory is closed and then
 134 reopened, prior values returned by
 135 .Fn telldir
 136 will no longer be valid.
 137 .Pp
 138 The
 139 .Fn seekdir
 140 function
 141 sets the position of the next
 142 .Fn readdir
 143 operation on the
 144 .Em directory stream .
 145 The new position reverts to the one associated with the
 146 .Em directory stream
 147 when the
 148 .Fn telldir
 149 operation was performed.
 150 .Pp
 151 The
 152 .Fn rewinddir
 153 function
 154 resets the position of the named
 155 .Em directory stream
 156 to the beginning of the directory.
 157 .Pp
 158 The
 159 .Fn closedir
 160 function
 161 closes the named
 162 .Em directory stream
 163 and frees the structure associated with the
 164 .Fa dirp
 165 pointer,
 166 returning 0 on success.
 167 On failure, \-1 is returned and the global variable
 168 .Va errno
 169 is set to indicate the error.
 170 .Pp
 171 The
 172 .Fn dirfd
 173 function
 174 returns the integer file descriptor associated with the named
 175 .Em directory stream ,
 176 see
 177 .Xr open 2 .
 178 .Pp
 179 Sample code which searches a directory for entry ``name'' is:
 180 .Bd -literal -offset indent
 181 len = strlen(name);
 182 dirp = opendir(".");
 183 while ((dp = readdir(dirp)) != NULL)
 184         if (dp->d_namlen == len && !strcmp(dp->d_name, name)) {
 185                 (void)closedir(dirp);
 186                 return FOUND;
 187         }
 188 (void)closedir(dirp);
 189 return NOT_FOUND;
 190 .Ed
 191 .Sh SEE ALSO
 192 .Xr close 2 ,
 193 .Xr lseek 2 ,
 194 .Xr open 2 ,
 195 .Xr read 2 ,
 196 .Xr dir 5
 197 .Sh HISTORY
 198 The
 199 .Fn opendir ,
 200 .Fn readdir ,
 201 .Fn telldir ,
 202 .Fn seekdir ,
 203 .Fn rewinddir ,
 204 .Fn closedir ,
 205 and
 206 .Fn dirfd
 207 functions appeared in
 208 .Bx 4.2 .