icon Top 9 categories map      RocketAware > man pages >

scandir(3)

Tips: Browse or Search all pages for efficient awareness of more than 6000 of the most popular reusable and open source applications, functions, libraries, and FAQs.


The "RKT couplings" below include links to source code, updates, additional information, advice, FAQs, and overviews.


Home

Search all pages


Subjects

By activity
Professions, Sciences, Humanities, Business, ...

User Interface
Text-based, GUI, Audio, Video, Keyboards, Mouse, Images,...

Text Strings
Conversions, tests, processing, manipulation,...

Math
Integer, Floating point, Matrix, Statistics, Boolean, ...

Processing
Algorithms, Memory, Process control, Debugging, ...

Stored Data
Data storage, Integrity, Encryption, Compression, ...

Communications
Networks, protocols, Interprocess, Remote, Client Server, ...

Hard World
Timing, Calendar and Clock, Audio, Video, Printer, Controls...

File System
Management, Filtering, File & Directory access, Viewers, ...

    

RocketLink!--> Man page versions: OpenBSD FreeBSD RedHat Others



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

NAME
     scandir, alphasort - scan a directory



SYNOPSIS
     #include <sys/types.h>
     #include <dirent.h>

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

     int
     alphasort(const void *d1, const void *d2);

DESCRIPTION
     The scandir() function reads the directory dirname 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 namelist.

     The select parameter is a pointer to a user-supplied subroutine which is
     called by scandir() 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 select is NULL, then all directory entries will be in-
     cluded.

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

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

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

OpenBSD 2.6                      June 4, 1993                                1

Source: OpenBSD 2.6 man pages. Copyright: Portions are copyrighted by BERKELEY
SOFTWARE DESIGN, INC., The Regents of the University of California, Massachusetts
Institute of Technology, Free Software Foundation, FreeBSD Inc., and others.



(Corrections, notes, and links courtesy of RocketAware.com)


[Detailed Topics]
FreeBSD Sources for scandir(3) functions
OpenBSD sources for scandir(3)


[Overview Topics]

Up to: Directory Access - Accessing directories of files, browsing, management, et al.


RocketLink!--> Man page versions: OpenBSD FreeBSD RedHat Others






Rapid-Links: Search | About | Comments | Submit Path: RocketAware > man pages > scandir.3/
RocketAware.com is a service of Mib Software
Copyright 1999, Forrest J. Cavalier III. All Rights Reserved.
We welcome submissions and comments