SCANDIR
Section: C Library Functions (3)
Index
Return to Main Contents
BSD mandoc
BSD 4.2
NAME
scandir
alphasort
- scan a directory
SYNOPSIS
Fd #include <sys/types.h>
Fd #include <dirent.h>
Ft int
Fn scandir const char *dirname struct dirent ***namelist int \*(lp*select\*(rp\*(lpstruct dirent *\*(rp int \*(lp*compar\*(rp\*(lpconst void *, const void *\*(rp
Ft int
Fn alphasort const void *d1 const void *d2
DESCRIPTION
The
Fn scandir
function
reads the directory
Fa dirname
and builds an array of pointers to directory
entries using
malloc(3).
It returns the number of entries in the array.
A pointer to the array of directory entries is stored in the location
referenced by
Fa namelist .
The
Fa select
parameter is a pointer to a user supplied subroutine which is called by
Fn 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
Fa select
is null, then all the directory entries will be included.
The
Fa 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.
The
Fn alphasort
function
is a routine which can be used for the
Fa compar
parameter to sort the array alphabetically.
The memory allocated for the array can be deallocated with
free(3),
by freeing each pointer in the array and then the array itself.
DIAGNOSTICS
Returns -1 if the directory cannot be opened for reading or if
malloc(3)
cannot allocate enough memory to hold all the data structures.
SEE ALSO
directory(3),
malloc(3),
qsort(3),
dir(5)
HISTORY
The
Fn scandir
and
Fn alphasort
functions appeared in
BSD 4.2
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- DIAGNOSTICS
-
- SEE ALSO
-
- HISTORY
-
This document was created by
man2html,
using the manual pages.
Time: 06:41:58 GMT, May 19, 2025