SCANDIR(3)

名前
scandir, scandirat, alphasort, versionsort - ディレクトリを走査する

書式
#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>          /* 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 **));

    glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

scandir(), alphasort():
    /* glibc 2.10 以降: */ _POSIX_C_SOURCE >= 200809L
        || /* glibc 2.19 以前: */ _BSD_SOURCE || _SVID_SOURCE

versionsort(): _GNU_SOURCE

scandirat(): _GNU_SOURCE

説明
関数 scandir() はディレクトリ dirp を走査し、 ディレクトリの各エントリーを引数として filter() を呼び出す。 filter() が 0 以外の値を返すエントリーは、 malloc(3) により確保された文字列に格納され、比較関数 compar() を用いた qsort(3) によりソートされて、 malloc(3) により確保された配列 namelist にまとめられる。 filter が NULL ならば、すべてのエントリーが選択される。

比較関数 compar() には alphasort() 関数と versionsort() 関数を使用できる。 alphasort() は strcoll(3) を用いてディレクトリエントリーをソートする。 versionsort() は文字列 (*a)->d_name と (*b)->d_name に対して strverscmp(3) を用いる。

  scandirat()
scandirat() 関数は scandir() と全く同様の動作をする。ここでは差分を説明する。

dirp で指定されたパス名が相対パスの場合、ファイルディスクリプター dirfd が参照するディレクトリからの相対パスと解釈される。 (一方、scandir() の場合は、相対パス名は、呼び出したプロセスのカレントワーキングディレクトリからの相対パスと解釈される。)

dirp が相対パスで dirfd が特別な値 AT_FDCWD の場合、 dirp は (scandir() と同様に) 呼び出したプロセスのカレントワーキングディレクトリからの相対パスと解釈される。

dirp が絶対パスの場合、dirfd は無視される。

scandirat() が必要な理由については openat(2) を参照のこと。

返り値
scandir() 関数は、選択されたディレクトリのエントリー数を返す。 エラーの場合、 -1 を返し、 errno にエラーの原因を示す値を設定する。

関数 alphasort() と versionsort() は、 1 番目の引数が 2 番目の引数に対して [小さい/等しい/大きい] かに応じて、 0 より [小さい/等しい/大きい] 整数値を返す。

エラー

ENOENT
    dirp で指定されたパスが存在しない。

ENOMEM
    操作を完了するのに十分なメモリーがない。

ENOTDIR
    dirp で指定されたパスがディレクトリではない。

scandirat() では、上記に加えて以下のエラーも発生する。

EBADF
    dirfd が有効なファイルディスクリプターではない。

ENOTDIR
    dirp が相対パスで、dirfd がディレクトリ以外のファイルを参照しているファイルディスクリプターである。

バージョン
versionsort() は、glibc バージョン 2.1 で追加された。

scandirat() は glibc バージョン 2.15 で追加された。

属性
この節で使用されている用語の説明については、 attributes(7) を参照。
インターフェース | 属性 | 値
scandir(), scandirat() | Thread safety | MT-Safe
alphasort(), versionsort() | Thread safety | MT-Safe locale

準拠
alphasort(), scandir(): 4.3BSD, POSIX.1-2008.

versionsort() と scandirat() は GNU 拡張である。

注意
glibc 2.1 以降では alphasort() は strcoll(3) を呼び出す。 alphasort() は以前は strcmp(3) を使っていた。

glibc 2.10 より前では、 alphasort() と versionsort() の 2 つの引数の型は const void * であった。 alphasort() が POSIX.1-2008 で標準化された際、引数の型は型安全な const struct dirent ** として規定され、 glibc 2.10 は alphasort() (と非標準の versionsort()) の定義を標準に合致するように変更した。

例
以下のプログラムは、現在のディレクトリ内のファイル一覧を逆順で表示する。

  プログラムのソース
    #define _DEFAULT_SOURCE
    #include <dirent.h>
    #include <stdio.h>
    #include <stdlib.h>
    int
    main(void)
    {
        struct dirent **namelist;
        int n;
        n = scandir(".", &namelist, NULL, alphasort);
        if (n == -1) {
            perror("scandir");
            exit(EXIT_FAILURE);
        }
        while (n--) {
            printf("%s\n", namelist[n]->d_name);
            free(namelist[n]);
        }
        free(namelist);
        exit(EXIT_SUCCESS);
    }

関連項目
closedir(3), fnmatch(3), opendir(3), readdir(3), rewinddir(3), seekdir(3), strcmp(3), strcoll(3), strverscmp(3), telldir(3)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 5.10 の一部である。プロジェクトの説明とバグ報告に関する情報は https://www.kernel.org/doc/man-pages/ に書かれている。