4.4BSD/usr/share/man/cat3/scandir.0

SCANDIR(3)                  BSD Programmer's Manual                 SCANDIR(3)

NNAAMMEE
     ssccaannddiirr, aallpphhaassoorrtt - scan a directory

SSYYNNOOPPSSIISS
     ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
     ##iinncclluuddee <<ddiirreenntt..hh>>

     _i_n_t
     ssccaannddiirr(_c_o_n_s_t _c_h_a_r _*_d_i_r_n_a_m_e, _s_t_r_u_c_t _d_i_r_e_n_t _*_*_*_n_a_m_e_l_i_s_t,
             _i_n_t (_*_s_e_l_e_c_t)(_s_t_r_u_c_t _d_i_r_e_n_t _*),
             _i_n_t (_*_c_o_m_p_a_r)(_c_o_n_s_t _v_o_i_d _*_, _c_o_n_s_t _v_o_i_d _*));

     _i_n_t
     aallpphhaassoorrtt(_c_o_n_s_t _v_o_i_d _*_d_1, _c_o_n_s_t _v_o_i_d _*_d_2);

DDEESSCCRRIIPPTTIIOONN
     The ssccaannddiirr() function reads the directory _d_i_r_n_a_m_e 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 _n_a_m_e_l_i_s_t.

     The _s_e_l_e_c_t parameter is a pointer to a user supplied subroutine which is
     called by ssccaannddiirr() to select which entries are to be included in the ar-
     ray.  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 _s_e_l_e_c_t is null, then all the directory entries will be
     included.

     The _c_o_m_p_a_r 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 aallpphhaassoorrtt() function is a routine which can be used for the _c_o_m_p_a_r
     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.

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

SSEEEE AALLSSOO
     directory(3),  malloc(3),  qsort(3),  dir(5)

HHIISSTTOORRYY
     The ssccaannddiirr() and aallpphhaassoorrtt() functions appeared in 4.2BSD.

4.2 Berkeley Distribution        June 4, 1993                                1