1.\" $OpenBSD: scandir.3,v 1.7 2000/12/24 00:30:51 aaron Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.Dd June 4, 1993 35.Dt SCANDIR 3 36.Os 37.Sh NAME 38.Nm scandir , 39.Nm alphasort 40.Nd scan a directory 41.Sh SYNOPSIS 42.Fd #include <sys/types.h> 43.Fd #include <dirent.h> 44.Ft int 45.Fn scandir "const char *dirname" "struct dirent ***namelist" "int \\*(lp*select\\*(rp\\*(lpstruct dirent *\\*(rp" "int \\*(lp*compar\\*(rp\\*(lpconst void *, const void *\\*(rp" 46.Ft int 47.Fn alphasort "const void *d1" "const void *d2" 48.Sh DESCRIPTION 49The 50.Fn scandir 51function reads the directory 52.Fa dirname 53and builds an array of pointers to directory 54entries using 55.Xr malloc 3 . 56It returns the number of entries in the array. 57A pointer to the array of directory entries is stored in the location 58referenced by 59.Fa namelist . 60.Pp 61The 62.Fa select 63parameter is a pointer to a user-supplied subroutine which is called by 64.Fn scandir 65to select which entries are to be included in the array. 66The select routine is passed a 67pointer to a directory entry and should return a non-zero 68value if the directory entry is to be included in the array. 69If 70.Fa select 71is 72.Dv NULL , 73then all directory entries will be included. 74.Pp 75The 76.Fa compar 77parameter is a pointer to a user-supplied subroutine which is passed to 78.Xr qsort 3 79to sort the completed array. 80If this pointer is 81.Dv NULL , 82the array is not sorted. 83.Pp 84The 85.Fn alphasort 86function is a routine which can be used for the 87.Fa compar 88parameter to sort the array alphabetically. 89.Pp 90The memory allocated for the array can be deallocated with 91.Xr free 3 , 92by freeing each pointer in the array and then the array itself. 93.Sh DIAGNOSTICS 94Returns \-1 if the directory cannot be opened for reading or if 95.Xr malloc 3 96cannot allocate enough memory to hold all the data structures. 97.Sh SEE ALSO 98.Xr directory 3 , 99.Xr malloc 3 , 100.Xr qsort 3 , 101.Xr dir 5 102.Sh HISTORY 103The 104.Fn scandir 105and 106.Fn alphasort 107functions appeared in 108.Bx 4.2 . 109