Copyright (c) 1983 Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)scandir.3 6.3 (Berkeley) 08/03/88

C 5 scandir, alphasort - scan a directory

 #include <sys/types.h>  #include <sys/dir.h> 

 scandir(dirname, namelist, select, compar)  char *dirname;  struct direct *(*namelist[]);  int (*select)();  int (*compar)(); 

 alphasort(d1, d2)  struct direct **d1, **d2; 

Scandir reads the directory dirname and builds an array of pointers to directory entries using malloc (3). It returns the number of entries in the array and a pointer to the array through namelist .

The select parameter is a pointer to a user supplied subroutine which is called by scandir to select which entries are to be included in the array. The select routine is passed a pointer to a directory entry and should return a non-zero value if the directory entry is to be included in the array. If select is null, then all the directory entries will be included.

The compar parameter is a pointer to a user supplied subroutine which is passed to qsort (3) to sort the completed array. If this pointer is null, the array is not sorted. Alphasort is a routine which can be used for the compar parameter to sort the array alphabetically.

The memory allocated for the array can be deallocated with free (see malloc (3)) by freeing each pointer in the array and the array itself.

directory(3), malloc(3), qsort(3), dir(5) Returns -1 if the directory cannot be opened for reading or if malloc (3) cannot allocate enough memory to hold all the data structures.