Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

alphasort(3) [bsd man page]

SCANDIR(3)						     Library Functions Manual							SCANDIR(3)

NAME
scandir, alphasort - scan a directory SYNOPSIS
#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; DESCRIPTION
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. SEE ALSO
directory(3), malloc(3), qsort(3), dir(5) 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. 4.2 Berkeley Distribution September 17, 1985 SCANDIR(3)

Check Out this Related Man Page

SCANDIR(3)						   BSD Library Functions Manual 						SCANDIR(3)

NAME
scandir, scandir_b, alphasort -- scan a directory SYNOPSIS
#include <sys/types.h> #include <dirent.h> int scandir(const char *dirname, struct dirent ***namelist, int (*select)(const struct dirent *), int (*compar)(const struct dirent **, const struct dirent **)); int alphasort(const struct dirent **d1, const struct dirent **d2); int scandir_b(const char *dirname, struct dirent ***namelist, int (^select)(const struct dirent *), int (^compar)(const struct dirent **, const struct dirent **)); DESCRIPTION
The scandir() function reads the directory dirname and builds an array of pointers to directory entries using malloc(3). It returns the num- ber of entries in the array. A pointer to the array of directory entries is stored in the location referenced by namelist (even if the num- ber of entries is 0). The select argument 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 argument 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 alphasort() function is a routine which can be used for the compar argument 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. The scandir_b() function works the same way as the scandir() function, except that select and compar are blocks instead of subroutines. 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 scandir() and alphasort() functions appeared in 4.2BSD. The scandir_b() function appeared in Mac OS X 10.6. BSD
May 20, 2008 BSD
Man Page

Featured Tech Videos