SCANDIR(3)

NOM
scandir, scandirat, alphasort, versionsort - Sélectionner des éléments d'un répertoire

SYNOPSIS
#include <dirent.h>

int scandir(const char *dirp, struct dirent ***namelist,
    int (*filter)(const struct dirent *),
    int (*compar)(const struct dirent **, const struct dirent **));

int alphasort(const struct dirent **a, const struct dirent **b);

int versionsort(const struct dirent **a, const struct dirent **b);
#include <fcntl.h>          /* Définition des constantes AT_* */
#include <dirent.h>

int scandirat(int dirfd, const char *dirp, struct dirent ***namelist,
    int (*filter)(const struct dirent *),
    int (*compar)(const struct dirent **, const struct dirent **));

Exigences de macros de test de fonctionnalités pour la glibc (consultez feature_test_macros(7)) :

scandir(), alphasort() :
    _BSD_SOURCE || _SVID_SOURCE
    || /* Depuis la glibc 2.10 : */
        (_POSIX_C_SOURCE >= 200809L || _XOPEN_SOURCE >= 700)

versionsort() : _GNU_SOURCE

scandirat() : _GNU_SOURCE

DESCRIPTION
La fonction scandir() examine le répertoire dirp, en appelant filter() pour chaque élément rencontré. Les entrées pour lesquelles filter() renvoie une valeur non nulle sont stockées dans une table allouée avec malloc(3), triée avec qsort(3) en utilisant la fonction de comparaison compar(), puis regroupées dans une table namelist allouée avec malloc(3). Si filter est NULL, toutes les entrées sont sélectionnées.

Les fonctions alphasort() et versionsort() peuvent être utilisées comme fonction de comparaison compar. La première trie les entrées du répertoire en ordre alphabétique en utilisant strcoll(3), la seconde en utilisant strverscmp(3) sur les chaînes (*a)->d_name et (*b)->d_name.

  scandirat()
La fonction scandirat() fonctionne exactement comme scandir(3), les seules différences étant décrites ici. Si le nom de chemin donné dans dirp est relatif, il est considéré relatif au répertoire référencé par le descripteur de fichier dirfd (plutôt que relatif au répertoire de travail actuel du processus appelant, comme avec scandir() pour un nom de chemin relatif). Si dirp est relatif et que dirfd est la valeur particulière AT_FDCWD, alors dirp est considéré relatif au répertoire de travail actuel du processus appelant (comme scandir()). Si dirp est absolu, alors dirfd est ignoré.

Consultez openat(2) pour une explication sur la nécessité de scandirat().

VALEUR RENVOYÉE
La fonction scandir() renvoie le nombre d'entrées de répertoires sélectionnées s'il réussit, ou -1 s'il échoue, avec errno qui contient le code d'erreur.

Les fonctions alphasort() et versionsort() renvoient un entier négatif, nul, ou positif si le premier argument est respectivement inférieur, égal ou supérieur au second.

ERREURS

ENOENT
    Le chemin n'existe pas dans dirp.

ENOMEM
    Pas assez de mémoire pour terminer l'opération.

ENOTDIR
    Le chemin n'est pas un répertoire de dirp.

Les erreurs supplémentaires suivantes peuvent se produire avec scandirat().

EBADF
    dirfd n'est pas un descripteur de fichier valable.

ENOTDIR
    dirp est un chemin relatif et dirfd est un descripteur de fichier référençant un fichier qui n'est pas un répertoire.

VERSIONS
versionsort() a été ajoutée à la glibc dans la version 2.1. scandirat() a été ajoutée à la glibc dans la version 2.15.

CONFORMITÉ
alphasort(), scandir() : BSD 4.3, POSIX.1-2008. versionsort() et scandirat() sont des extensions GNU.

NOTES
Depuis la glibc 2.1, la fonction alphasort() invoque strcoll(3). Dans les versions précédentes, elle appelait strcmp(3).

EXEMPLE
#define _SVID_SOURCE
/* Afficher le contenu du répertoire en ordre inverse */
#include <dirent.h>
int
main(void)
{
    struct dirent **namelist;
    int n;
    n = scandir(".", &namelist, NULL, alphasort);
    if (n < 0)
        perror("scandir");
    else {
        while (n--) {
            printf("%s\n", namelist[n]->d_name);
            free (namelist [n]);
        }
        free (namelist);
    }
}

VOIR AUSSI
closedir(3), fnmatch(3), opendir(3), readdir(3), rewinddir(3), seekdir(3), strcmp(3), strcoll(3), strverscmp(3), telldir(3)

COLOPHON
Cette page fait partie de la publication 3.70 du projet man-pages Linux. Une description du projet et des instructions pour signaler des anomalies peuvent être trouvées à l'adresse http://www.kernel.org/doc/man-pages/.

TRADUCTION
Depuis 2010, cette traduction est maintenue à l'aide de l'outil po4a <http://po4a.alioth.debian.org/> par l'équipe de traduction francophone au sein du projet perkamon <http://perkamon.alioth.debian.org/>.

Christophe Blaess <http://www.blaess.fr/christophe/> (1996-2003), Alain Portal <http://manpagesfr.free.fr/> (2003-2006). Nicolas François et l'équipe francophone de traduction de Debian (2006-2009).

Veuillez signaler toute erreur de traduction en écrivant à <perkamon-fr@traduc.org>.

Vous pouvez toujours avoir accès à la version anglaise de ce document en utilisant la commande « LC_ALL=C man <section> <page_de_man> ».