scandirのヘルプ・マニュアル
日本語 英語
scandir --help
man scandir
SCANDIR(3) Linux Programmer’s Manual SCANDIR(3)
名前
scandir, alphasort, versionsort - ディレクトリを走査する
書式
#include
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
を返す。
関数 alphasort() と versionsort() は 1 番目の引き数が 2 番目の引き数 に
対 して、 [小さい/等しい/大きい] かに応じて、0 より [小さい/等しい/大き
い] 値を返す。
エラー
ENOMEM 動作を完遂するにはメモリが足りない。
バージョン
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
int
main(void)
{
struct dirent **namelist;
int n;
n = scandir(".", &namelist, 0, 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)
GNU 2009-02-10 SCANDIR(3)
SCANDIR(3) Linux Programmer’s Manual SCANDIR(3)
NAME
scandir, alphasort, versionsort - scan a directory for matching entries
SYNOPSIS
#include
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);
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
scandir(), alphasort(): _BSD_SOURCE || _SVID_SOURCE
versionsort(): _GNU_SOURCE
DESCRIPTION
The scandir() function scans the directory dirp, calling filter() on
each directory entry. Entries for which filter() returns non-zero are
stored in strings allocated via malloc(3), sorted using qsort(3) with
the comparison function compar(), and collected in array namelist which
is allocated via malloc(3). If filter is NULL, all entries are
selected.
The alphasort() and versionsort() functions can be used as the compari-
son function compar(). The former sorts directory entries using str-
coll(3), the latter using strverscmp(3) on the strings (*a)->d_name and
(*b)->d_name.
RETURN VALUE
The scandir() function returns the number of directory entries selected
or -1 if an error occurs.
The alphasort() and versionsort() functions return an integer less
than, equal to, or greater than zero if the first argument is consid-
ered to be respectively less than, equal to, or greater than the sec-
ond.
ERRORS
ENOMEM Insufficient memory to complete the operation.
VERSIONS
versionsort() was added to glibc in version 2.1.
CONFORMING TO
alphasort() and scandir() are specified in POSIX.1-2008, and are widely
available. versionsort() is a GNU extension.
The functions scandir() and alphasort() are from 4.3BSD, and have been
available under Linux since libc4. Libc4 and libc5 use the more pre-
cise prototype
int alphasort(const struct dirent ** a,
const struct dirent **b);
but glibc 2.0 returns to the imprecise BSD prototype.
The function versionsort() is a GNU extension, available since glibc
2.1.
Since glibc 2.1, alphasort() calls strcoll(3); earlier it used str-
cmp(3).
EXAMPLE
#define _SVID_SOURCE
/* print files in current directory in reverse order */
#include
int
main(void)
{
struct dirent **namelist;
int n;
n = scandir(".", &namelist, 0, alphasort);
if (n < 0)
perror("scandir");
else {
while (n--) {
printf("%s\n", namelist[n]->d_name);
free(namelist[n]);
}
free(namelist);
}
}
SEE ALSO
closedir(3), fnmatch(3), opendir(3), readdir(3), rewinddir(3),
seekdir(3), strcmp(3), strcoll(3), strverscmp(3), telldir(3)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
GNU 2009-02-10 SCANDIR(3)