名前

       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 void *a, const void *b);

       int versionsort(const void *a, const void *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():
           _BSD_SOURCE || _SVID_SOURCE
           || /* glibc 2.10 以降: */
               (_POSIX_C_SOURCE >= 200809L || _XOPEN_SOURCE >= 700)

       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 で追加された。

準拠

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

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

注意

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

例

       #define _SVID_SOURCE
       /* カレントディレクトリのファイルを逆順に出力する */
       #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);
           }
       }

関連項目

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

この文書について

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