man3/scandir.3

   1 .\" Copyright (C) 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 18:26:16 1993 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified Thu Apr 11 17:11:33 1996 by Andries Brouwer (aeb@cwi.nl):
  31 .\"     Corrected type of compar routines, as suggested by
  32 .\"     Miguel Barreiro (enano@avalon.yaix.es).  Added example.
  33 .\" Modified Sun Sep 24 20:15:46 2000 by aeb, following Petter Reinholdtsen.
  34 .\" Modified 2001-12-26 by aeb, following Joey. Added versionsort.
  35 .\"
  36 .\" The pieces on scandirat(3) were copyright and licensed as follows.
  37 .\"
  38 .\" Copyright (c) 2012, Mark R. Bannister <cambridge@users.sourceforge.net>
  39 .\"        based on text in mkfifoat.3 Copyright (c) 2006, Michael Kerrisk
  40 .\"
  41 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
  42 .\" This is free documentation; you can redistribute it and/or
  43 .\" modify it under the terms of the GNU General Public License as
  44 .\" published by the Free Software Foundation; either version 2 of
  45 .\" the License, or (at your option) any later version.
  46 .\"
  47 .\" The GNU General Public License's references to "object code"
  48 .\" and "executables" are to be interpreted as the output of any
  49 .\" document formatting or typesetting system, including
  50 .\" intermediate and printed output.
  51 .\"
  52 .\" This manual is distributed in the hope that it will be useful,
  53 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  54 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  55 .\" GNU General Public License for more details.
  56 .\"
  57 .\" You should have received a copy of the GNU General Public
  58 .\" License along with this manual; if not, see
  59 .\" <http://www.gnu.org/licenses/>.
  60 .\" %%%LICENSE_END
  61 .\"
  62 .TH SCANDIR 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  63 .SH NAME
  64 scandir, scandirat, alphasort, versionsort \- scan
  65 a directory for matching entries
  66 .SH SYNOPSIS
  67 .nf
  68 .B #include <dirent.h>
  69 .PP
  70 .BI "int scandir(const char *restrict " dirp ,
  71 .BI "            struct dirent ***restrict " namelist ,
  72 .BI "            int (*" filter ")(const struct dirent *),"
  73 .BI "            int (*" compar ")(const struct dirent **,"
  74 .BR "                          const struct dirent **));"
  75 .PP
  76 .BI "int alphasort(const struct dirent **" a ", const struct dirent **" b );
  77 .BI "int versionsort(const struct dirent **" a ", const struct dirent **" b );
  78 .PP
  79 .BR "#include <fcntl.h>" "          /* Definition of AT_* constants */"
  80 .B #include <dirent.h>
  81 .PP
  82 .BI "int scandirat(int " dirfd ", const char *restrict " dirp ,
  83 .BI "            struct dirent ***restrict " namelist ,
  84 .BI "            int (*" filter ")(const struct dirent *),"
  85 .BI "            int (*" compar ")(const struct dirent **,"
  86 .BI "                          const struct dirent **));"
  87 .fi
  88 .PP
  89 .RS -4
  90 Feature Test Macro Requirements for glibc (see
  91 .BR feature_test_macros (7)):
  92 .RE
  93 .PP
  94 .BR scandir (),
  95 .BR alphasort ():
  96 .nf
  97     /* Since glibc 2.10: */ _POSIX_C_SOURCE >= 200809L
  98         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  99 .fi
 100 .PP
 101 .BR versionsort ():
 102 .nf
 103     _GNU_SOURCE
 104 .fi
 105 .PP
 106 .BR scandirat ():
 107 .nf
 108     _GNU_SOURCE
 109 .fi
 110 .SH DESCRIPTION
 111 The
 112 .BR scandir ()
 113 function scans the directory \fIdirp\fP, calling
 114 \fIfilter\fP() on each directory entry.
 115 Entries for which
 116 \fIfilter\fP() returns nonzero are stored in strings allocated via
 117 .BR malloc (3),
 118 sorted using
 119 .BR qsort (3)
 120 with the comparison
 121 function \fIcompar\fP(), and collected in array \fInamelist\fP
 122 which is allocated via
 123 .BR malloc (3).
 124 If \fIfilter\fP is NULL, all entries are selected.
 125 .PP
 126 The
 127 .BR alphasort ()
 128 and
 129 .BR versionsort ()
 130 functions can be used as the comparison function
 131 .IR compar ().
 132 The former sorts directory entries using
 133 .BR strcoll (3),
 134 the latter using
 135 .BR strverscmp (3)
 136 on the strings \fI(*a)\->d_name\fP and \fI(*b)\->d_name\fP.
 137 .SS scandirat()
 138 The
 139 .BR scandirat ()
 140 function operates in exactly the same way as
 141 .BR scandir (),
 142 except for the differences described here.
 143 .PP
 144 If the pathname given in
 145 .I dirp
 146 is relative, then it is interpreted relative to the directory
 147 referred to by the file descriptor
 148 .I dirfd
 149 (rather than relative to the current working directory of
 150 the calling process, as is done by
 151 .BR scandir ()
 152 for a relative pathname).
 153 .PP
 154 If
 155 .I dirp
 156 is relative and
 157 .I dirfd
 158 is the special value
 159 .BR AT_FDCWD ,
 160 then
 161 .I dirp
 162 is interpreted relative to the current working
 163 directory of the calling process (like
 164 .BR scandir ()).
 165 .PP
 166 If
 167 .I dirp
 168 is absolute, then
 169 .I dirfd
 170 is ignored.
 171 .PP
 172 See
 173 .BR openat (2)
 174 for an explanation of the need for
 175 .BR scandirat ().
 176 .SH RETURN VALUE
 177 The
 178 .BR scandir ()
 179 function returns the number of directory entries
 180 selected.
 181 On error, \-1 is returned, with
 182 .I errno
 183 set to indicate the error.
 184 .PP
 185 The
 186 .BR alphasort ()
 187 and
 188 .BR versionsort ()
 189 functions return an integer less than, equal to,
 190 or greater than zero if the first argument is considered to be
 191 respectively less than, equal to, or greater than the second.
 192 .SH ERRORS
 193 .TP
 194 .B ENOENT
 195 The path in \fIdirp\fR does not exist.
 196 .TP
 197 .B ENOMEM
 198 Insufficient memory to complete the operation.
 199 .TP
 200 .B ENOTDIR
 201 The path in \fIdirp\fR is not a directory.
 202 .PP
 203 The following additional errors can occur for
 204 .BR scandirat ():
 205 .TP
 206 .B EBADF
 207 .I dirfd
 208 is not a valid file descriptor.
 209 .TP
 210 .B ENOTDIR
 211 .I dirp
 212 is a relative path and
 213 .I dirfd
 214 is a file descriptor referring to a file other than a directory.
 215 .SH VERSIONS
 216 .BR versionsort ()
 217 was added to glibc in version 2.1.
 218 .PP
 219 .BR scandirat ()
 220 was added to glibc in version 2.15.
 221 .SH ATTRIBUTES
 222 For an explanation of the terms used in this section, see
 223 .BR attributes (7).
 224 .ad l
 225 .nh
 226 .TS
 227 allbox;
 228 lbx lb lb
 229 l l l.
 230 Interface       Attribute       Value
 231 T{
 232 .BR scandir (),
 233 .BR scandirat ()
 234 T}      Thread safety   MT-Safe
 235 T{
 236 .BR alphasort (),
 237 .BR versionsort ()
 238 T}      Thread safety   MT-Safe locale
 239 .TE
 240 .hy
 241 .ad
 242 .sp 1
 243 .SH CONFORMING TO
 244 .BR alphasort (),
 245 .BR scandir ():
 246 4.3BSD, POSIX.1-2008.
 247 .PP
 248 .BR versionsort ()
 249 and
 250 .BR scandirat ()
 251 are GNU extensions.
 252 .\" .LP
 253 .\" The functions
 254 .\" .BR scandir ()
 255 .\" and
 256 .\" .BR alphasort ()
 257 .\" are from 4.3BSD, and have been available under Linux since libc4.
 258 .\" Libc4 and libc5 use the more precise prototype
 259 .\" .sp
 260 .\" .nf
 261 .\"    int alphasort(const struct dirent ** a,
 262 .\"                  const struct dirent **b);
 263 .\" .fi
 264 .\" .sp
 265 .\" but glibc 2.0 returns to the imprecise BSD prototype.
 266 .SH NOTES
 267 Since glibc 2.1,
 268 .BR alphasort ()
 269 calls
 270 .BR strcoll (3);
 271 earlier it used
 272 .BR strcmp (3).
 273 .PP
 274 Before glibc 2.10, the two arguments of
 275 .BR alphasort ()
 276 and
 277 .BR versionsort ()
 278 were typed as
 279 .IR "const void\ *" .
 280 When
 281 .BR alphasort ()
 282 was standardized in POSIX.1-2008,
 283 the argument type was specified as the type-safe
 284 .IR "const struct dirent\ **",
 285 and glibc 2.10 changed the definition of
 286 .BR alphasort ()
 287 (and the nonstandard
 288 .BR versionsort ())
 289 to match the standard.
 290 .SH EXAMPLES
 291 The program below prints a list of the files in the current directory
 292 in reverse order.
 293 .\"
 294 .SS Program source
 295 \&
 296 .EX
 297 #define _DEFAULT_SOURCE
 298 #include <dirent.h>
 299 #include <stdio.h>
 300 #include <stdlib.h>
 301
 302 int
 303 main(void)
 304 {
 305     struct dirent **namelist;
 306     int n;
 307
 308     n = scandir(".", &namelist, NULL, alphasort);
 309     if (n == \-1) {
 310         perror("scandir");
 311         exit(EXIT_FAILURE);
 312     }
 313
 314     while (n\-\-) {
 315         printf("%s\en", namelist[n]\->d_name);
 316         free(namelist[n]);
 317     }
 318     free(namelist);
 319
 320     exit(EXIT_SUCCESS);
 321 }
 322 .EE
 323 .SH SEE ALSO
 324 .BR closedir (3),
 325 .BR fnmatch (3),
 326 .BR opendir (3),
 327 .BR readdir (3),
 328 .BR rewinddir (3),
 329 .BR seekdir (3),
 330 .BR strcmp (3),
 331 .BR strcoll (3),
 332 .BR strverscmp (3),
 333 .BR telldir (3)