scandir(3c) [sunos man page]

scandir(3C)						   Standard C Library Functions 					       scandir(3C)

NAME

       scandir, 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 (*dcomp)(const struct dirent  **,
       const struct dirent **));

       int alphasort(const struct dirent **d1, const struct dirent **d2);

DESCRIPTION

       The scandir() function reads the directory dirname using readdir(3C) and builds an array of pointers to directory entries using malloc(3C).
       The  namelist  argument is a pointer to an array of structure pointers. The select argument is a pointer to a routine that is called with a
       pointer to a directory entry and returns a non-zero value if the directory entry is included in the array. If this pointer  is  NULL,  then
       all the directory entries are included. The dcomp argument is a pointer to a routine that is passed to qsort(3C), which sorts the completed
       array. If this pointer is NULL, the array is not sorted.

       The alphasort() function can be used as the dcomp() function parameter for the scandir() function to sort the directory entries into alpha-
       betical order, as if by the strcoll(3C) function. Its arguments are the two directory entries to compare.

RETURN VALUES

       The  scandir()  function returns the number of entries in the array and a pointer to the array through the namelist argument. When an error
       is encountered, scandir() returns -1 and errno is set to indicate the error.

       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 when both are interpreted as appropriate to the current locale.
       There is no return value reserved to indicate an error.

ERRORS

       The scandir() function will fail if:

       EOVERFLOW       The number of directory entries exceeds the number that can be represented by an int.

USAGE

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

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Stable			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |See below.		   |
       +-----------------------------+-----------------------------+

       The scandir() function is Unsafe. The alphasort() function is Safe.

SEE ALSO

       malloc(3C), qsort(3C), readdir(3C), strcoll(3C), attributes(5), lf64(5)

SunOS 5.10							    4 May 2004							       scandir(3C)

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 <dirent.h>

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

     int
     scandir_b(const char *dirname, struct dirent ***namelist, int (*select(rp(const struct dirent *),
	 int (^compar)(const struct dirent **, const struct dirent **));

     int
     alphasort(const struct dirent **d1, const struct dirent **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 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 using strcoll(3).

     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 behaves in the same way as scandir(), but takes blocks as arguments instead of function pointers and calls qsort_b()
     rather than qsort().

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), strcoll(3), dir(5)

HISTORY

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

BSD
								  January 3, 2010							       BSD

Linux and UNIX Man Pages

scandir(3c) [sunos man page]

Check Out this Related Man Page