名前

       scandir, 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);

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

       scandir(), alphasort(): _BSD_SOURCE || _SVID_SOURCE
       versionsort(): _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)  を用いる。

返り値

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

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

エラー

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

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

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

バージョン

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

準拠

       alphasort()    と   scandir()    は   POSIX.1-2008  で規定されており、広く利用可能である。
       versionsort()  は GNU 拡張である。

       関数 scandir()  と alphasort()  は 4.3BSD から取り入れられ、Linux では libc4  から使用可能
       になった。 libc4 と libc5 では以下のようなもっと詳細なプロトタイプを使っている。

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

       しかし glibc 2.0 では不正確な BSD のプロトタイプに戻った。

       関数 versionsort()  は GNU の拡張であり、glibc 2.1 以降で使用可能である。

       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),  scandirat(3),  seekdir(3),
       strcmp(3), strcoll(3), strverscmp(3), telldir(3)

この文書について

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