scandir(3ucb) [opensolaris man page]

scandir(3UCB)					     SunOS/BSD Compatibility Library Functions					     scandir(3UCB)

NAME

       scandir, alphasort - scan a directory

SYNOPSIS

       /usr/ucb/cc [ flag... ] file...
       #include <sys/types.h>
       #include <sys/dir.h>

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

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

DESCRIPTION

       The scandir() function reads the directory dirname and builds an array of pointers to directory entries using malloc(3C). The second param-
       eter is a pointer to an array of structure pointers. The third parameter is a pointer to a routine which is called  with  a  pointer  to  a
       directory  entry  and  should return a non zero value if the directory entry should be included in the array. If this pointer is NULL, then
       all the directory entries will be included. The last argument is a pointer to a routine which is passed to qsort(3C), which sorts the  com-
       pleted array. If this pointer is NULL, the array is not sorted.

       The alphasort() function sorts the array alphabetically.

RETURN VALUES

       The  scandir() function returns the number of entries in the array and a pointer to the array through the parameter namelist. The scandir()
       function returns -1 if the directory cannot be opened for reading or if malloc(3C) cannot allocate enough  memory  to  hold  all  the  data
       structures.

       The  alphasort() function returns an integer greater than, equal to, or less than 0 if the directory entry name pointed to by d1 is greater
       than, equal to, or less than the directory entry name pointed to by d2.

USAGE

       The scandir() and alphasort() functions have transitional interfaces for 64-bit file offsets. See lf64(5).

SEE ALSO

       cc(1B), getdents(2), malloc(3C), qsort(3C), readdir(3UCB), readdir(3C), lf64(5)

NOTES

       Use of these functions should be restricted to applications written on BSD platforms.  Use of  these  functions	with  any  of  the  system
       libraries or in multithreaded applications is unsupported.

SunOS 5.11							    30 Oct 2007 						     scandir(3UCB)

Check Out this Related Man Page

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

NAME

     scandir, alphasort -- scan a directory

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

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

     int
     scandir(const char *dirname, struct dirent ***namelist, int (*select)(const struct dirent *), int (*compar)(const void *, const void *));

     int
     alphasort(const void *d1, const void *d2);

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.

     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.

     The alphasort() function 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(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), dirent(3), malloc(3), qsort(3)

STANDARDS

     The scandir() and alphasort() functions conform to IEEE Std 1003.1-2008 (``POSIX.1'').

HISTORY

     The scandir() and alphasort() functions appeared in 4.2BSD.

BSD
								  April 29, 2010							       BSD

Linux and UNIX Man Pages

scandir(3ucb) [opensolaris man page]

Check Out this Related Man Page