mirror of
https://github.com/GnoConsortium/gno.git
synced 2024-09-11 14:54:54 +00:00
121 lines
3.9 KiB
Groff
121 lines
3.9 KiB
Groff
.\" Copyright (c) 1983, 1991, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)scandir.3 8.1 (Berkeley) 6/4/93
|
|
.\"
|
|
.TH SCANDIR 3 "27 January 1997" GNO "Library Routines"
|
|
.SH NAME
|
|
.BR scandir ,
|
|
.BR alphasort
|
|
\- scan a directory
|
|
.SH SYNOPSIS
|
|
#include <sys/types.h>
|
|
.br
|
|
#include <dirent.h>
|
|
.sp 1
|
|
int
|
|
\fBscandir\fR (const char *\fIdirname\fR,
|
|
struct dirent ***\fInamelist\fR,
|
|
int (*\fIselect\fR) (struct dirent *),
|
|
int (*\fIcompar\fR) (const void *, const void *));
|
|
.sp 1
|
|
int
|
|
alphasort (const void *d1, const void *d2);
|
|
.sp 1
|
|
int
|
|
alphacasesort (const void *d1, const void *d2);
|
|
.SH DESCRIPTION
|
|
The
|
|
.BR scandir
|
|
function
|
|
reads the directory
|
|
.I dirname
|
|
and builds an array of pointers to directory
|
|
entries using
|
|
.BR 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
|
|
.IR namelist .
|
|
.LP
|
|
The
|
|
.I select
|
|
parameter is a pointer to a user supplied subroutine which is called by
|
|
.BR 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
|
|
.I select
|
|
is null, then all the directory entries will be included.
|
|
.LP
|
|
The
|
|
.I compar
|
|
parameter is a pointer to a user supplied subroutine which is passed to
|
|
.BR qsort (3)
|
|
to sort the completed array.
|
|
If this pointer is null, the array is not sorted.
|
|
.LP
|
|
The
|
|
.BR alphasort
|
|
function
|
|
is a routine which can be used for the
|
|
.I compar
|
|
parameter to sort the array alphabetically.
|
|
.LP
|
|
The
|
|
.BR alphacasesort
|
|
function is similar to
|
|
.BR alphasort ,
|
|
but can be used for sorting in a case-insensitive manner, and is useful
|
|
for the case-insensitive filesystems used by GNO. This function is
|
|
specific to GNO.
|
|
.LP
|
|
The memory allocated for the array can be deallocated with
|
|
.BR free (3),
|
|
by freeing each pointer in the array and then the array itself.
|
|
.SH DIAGNOSTICS
|
|
Returns \-1 if the directory cannot be opened for reading or if
|
|
.BR malloc (3)
|
|
cannot allocate enough memory to hold all the data structures.
|
|
.SH SEE ALSO
|
|
.BR directory (3),
|
|
.BR malloc (3),
|
|
.BR qsort (3),
|
|
.BR dir (5)
|
|
.SH HISTORY
|
|
The
|
|
.BR scandir
|
|
and
|
|
.BR alphasort
|
|
functions appeared in 4.2BSD.
|