scandir.3ucb revision c10c16dec587a0662068f6e2991c29ed3a9db943
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
scandir 3UCB "30 Oct 2007" "SunOS 5.11" "SunOS/BSD Compatibility Library Functions"
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 parameter 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 completed 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

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.