.\" Copyright (C) 1993 David Metcalfe (david@prism.demon.co.uk) .\" .\" %%%LICENSE_START(VERBATIM) .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of this .\" manual under the conditions for verbatim copying, provided that the .\" entire resulting derived work is distributed under the terms of a .\" permission notice identical to this one. .\" .\" Since the Linux kernel and libraries are constantly changing, this .\" manual page may be incorrect or out-of-date. The author(s) assume no .\" responsibility for errors or omissions, or for damages resulting from .\" the use of the information contained herein. The author(s) may not .\" have taken the same level of care in the production of this manual, .\" which is licensed free of charge, as they might when working .\" professionally. .\" .\" Formatted or processed versions of this manual, if unaccompanied by .\" the source, must acknowledge the copyright and authors of this work. .\" %%%LICENSE_END .\" .\" References consulted: .\" Linux libc source code .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:26:16 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Thu Apr 11 17:11:33 1996 by Andries Brouwer (aeb@cwi.nl): .\" Corrected type of compar routines, as suggested by .\" Miguel Barreiro (enano@avalon.yaix.es). Added example. .\" Modified Sun Sep 24 20:15:46 2000 by aeb, following Petter Reinholdtsen. .\" Modified 2001-12-26 by aeb, following Joey. Added versionsort. .\" .\" The pieces on scandirat(3) were copyright and licensed as follows. .\" .\" Copyright (c) 2012, Mark R. Bannister .\" based on text in mkfifoat.3 Copyright (c) 2006, Michael Kerrisk .\" .\" %%%LICENSE_START(GPLv2+_DOC_FULL) .\" This is free documentation; you can redistribute it and/or .\" modify it under the terms of the GNU General Public License as .\" published by the Free Software Foundation; either version 2 of .\" the License, or (at your option) any later version. .\" .\" The GNU General Public License's references to "object code" .\" and "executables" are to be interpreted as the output of any .\" document formatting or typesetting system, including .\" intermediate and printed output. .\" .\" This manual is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public .\" License along with this manual; if not, see .\" . .\" %%%LICENSE_END .\" .\"******************************************************************* .\" .\" This file was generated with po4a. Translate the source file. .\" .\"******************************************************************* .\" .\" Japanese Version Copyright (c) 1998 Hiroaki Nagoya all rights reserved. .\" Translated Thu May 28 1998 by Hiroaki Nagoya .\" Updated & Modified Sat Jan 19 18:22:21 JST 2002 .\" by Yuichi SATO .\" Updated & Modified Sun Jan 16 08:12:04 JST 2005 .\" by Yuichi SATO .\" .TH SCANDIR 3 2020\-06\-09 GNU "Linux Programmer's Manual" .SH 名前 scandir, scandirat, alphasort, versionsort \- ディレクトリを走査する .SH 書式 .nf \fB#include \fP .PP \fBint scandir(const char *\fP\fIdirp\fP\fB, struct dirent ***\fP\fInamelist\fP\fB,\fP .RS \fBint (*\fP\fIfilter\fP\fB)(const struct dirent *),\fP \fBint (*\fP\fIcompar\fP\fB)(const struct dirent **, const struct dirent **));\fP .RE .PP \fBint alphasort(const struct dirent **\fP\fIa\fP\fB, const struct dirent **\fP\fIb\fP\fB);\fP .PP \fBint versionsort(const struct dirent **\fP\fIa\fP\fB, const struct dirent **\fP\fIb\fP\fB);\fP \fB#include \fP /* AT_* 定数の定義 */ \fB#include \fP .PP \fBint scandirat(int \fP\fIdirfd\fP\fB, const char *\fP\fIdirp\fP\fB,\fP \fBstruct dirent ***\fP\fInamelist\fP\fB,\fP .RS \fBint (*\fP\fIfilter\fP\fB)(const struct dirent *),\fP \fBint (*\fP\fIcompar\fP\fB)(const struct dirent **, const struct dirent **));\fP .RE .fi .PP .RS -4 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7) 参照): .RE .PP \fBscandir\fP(), \fBalphasort\fP(): .br .RS 4 .PD 0 .ad b /* glibc 2.10 以降: */ _POSIX_C_SOURCE\ >=\ 200809L || /* glibc 2.19 以前: */ _BSD_SOURCE || _SVID_SOURCE .PD .RE .PP \fBversionsort\fP(): _GNU_SOURCE .PP \fBscandirat\fP(): _GNU_SOURCE .SH 説明 関数 \fBscandir\fP() はディレクトリ \fIdirp\fP を走査し、 ディレクトリの各エントリーを引数として \fIfilter\fP() を呼び出す。 \fIfilter\fP() が 0 以外の値を返すエントリーは、 \fBmalloc\fP(3) により確保された文字列に格納され、比較関数 \fIcompar\fP() を用いた \fBqsort\fP(3) によりソートされて、 \fBmalloc\fP(3) により確保された配列 \fInamelist\fP にまとめられる。 \fIfilter\fP が NULL ならば、すべてのエントリーが選択される。 .PP 比較関数 \fIcompar\fP() には \fBalphasort\fP() 関数と \fBversionsort\fP() 関数を使用できる。 \fBalphasort\fP() は \fBstrcoll\fP(3) を用いてディレクトリエントリーをソートする。 \fBversionsort\fP() は文字列 \fI(*a)\->d_name\fP と \fI(*b)\->d_name\fP に対して \fBstrverscmp\fP(3) を用いる。 .SS scandirat() \fBscandirat\fP() 関数は \fBscandir\fP() と全く同様の動作をする。ここでは差分を説明する。 .PP \fIdirp\fP で指定されたパス名が相対パスの場合、ファイルディスクリプター \fIdirfd\fP が参照するディレクトリからの相対パスと解釈される。 (一方、\fBscandir\fP() の場合は、相対パス名は、呼び出したプロセスのカレントワーキングディレクトリからの相対パスと解釈される。) .PP \fIdirp\fP が相対パスで \fIdirfd\fP が特別な値 \fBAT_FDCWD\fP の場合、 \fIdirp\fP は (\fBscandir\fP() と同様に) 呼び出したプロセスのカレントワーキングディレクトリからの相対パスと解釈される。 .PP \fIdirp\fP が絶対パスの場合、\fIdirfd\fP は無視される。 .PP \fBscandirat\fP() が必要な理由については \fBopenat\fP(2) を参照のこと。 .SH 返り値 \fBscandir\fP() 関数は、選択されたディレクトリのエントリー数を返す。 エラーの場合、 \-1 を返し、 \fIerrno\fP にエラーの原因を示す値を設定する。 .PP 関数 \fBalphasort\fP() と \fBversionsort\fP() は、 1 番目の引数が 2 番目の引数に対して [小さい/等しい/大きい] かに応じて、 0 より [小さい/等しい/大きい] 整数値を返す。 .SH エラー .TP \fBENOENT\fP \fIdirp\fP で指定されたパスが存在しない。 .TP \fBENOMEM\fP 操作を完了するのに十分なメモリーがない。 .TP \fBENOTDIR\fP \fIdirp\fP で指定されたパスがディレクトリではない。 .PP \fBscandirat\fP() では、上記に加えて以下のエラーも発生する。 .TP \fBEBADF\fP \fIdirfd\fP が有効なファイルディスクリプターではない。 .TP \fBENOTDIR\fP \fIdirp\fP が相対パスで、\fIdirfd\fP がディレクトリ以外のファイルを参照しているファイルディスクリプターである。 .SH バージョン \fBversionsort\fP() は、glibc バージョン 2.1 で追加された。 .PP \fBscandirat\fP() は glibc バージョン 2.15 で追加された。 .SH 属性 この節で使用されている用語の説明については、 \fBattributes\fP(7) を参照。 .TS allbox; lbw26 lb lb l l l. インターフェース 属性 値 T{ \fBscandir\fP(), \fBscandirat\fP() T} Thread safety MT\-Safe T{ \fBalphasort\fP(), \fBversionsort\fP() T} Thread safety MT\-Safe locale .TE .sp 1 .SH 準拠 \fBalphasort\fP(), \fBscandir\fP(): 4.3BSD, POSIX.1\-2008. .PP .\" .LP .\" The functions .\" .BR scandir () .\" and .\" .BR alphasort () .\" are from 4.3BSD, and have been available under Linux since libc4. .\" Libc4 and libc5 use the more precise prototype .\" .sp .\" .nf .\" int alphasort(const struct dirent ** a, .\" const struct dirent **b); .\" .fi .\" .sp .\" but glibc 2.0 returns to the imprecise BSD prototype. \fBversionsort\fP() と \fBscandirat\fP() は GNU 拡張である。 .SH 注意 glibc 2.1 以降では \fBalphasort\fP() は \fBstrcoll\fP(3) を呼び出す。 \fBalphasort\fP() は以前は \fBstrcmp\fP(3) を使っていた。 .PP glibc 2.10 より前では、 \fBalphasort\fP() と \fBversionsort\fP() の 2 つの引数の型は \fIconst void\ *\fP であった。 \fBalphasort\fP() が POSIX.1\-2008 で標準化された際、引数の型は型安全な \fIconst struct dirent\ **\fP として規定され、 glibc 2.10 は \fBalphasort\fP() (と非標準の \fBversionsort\fP()) の定義を標準に合致するように変更した。 .SH 例 .\" 以下のプログラムは、現在のディレクトリ内のファイル一覧を逆順で表示する。 .SS プログラムのソース \& .EX #define _DEFAULT_SOURCE #include #include #include 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\en", namelist[n]\->d_name); free(namelist[n]); } free(namelist); exit(EXIT_SUCCESS); } .EE .SH 関連項目 \fBclosedir\fP(3), \fBfnmatch\fP(3), \fBopendir\fP(3), \fBreaddir\fP(3), \fBrewinddir\fP(3), \fBseekdir\fP(3), \fBstrcmp\fP(3), \fBstrcoll\fP(3), \fBstrverscmp\fP(3), \fBtelldir\fP(3) .SH この文書について この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 5.10 の一部である。プロジェクトの説明とバグ報告に関する情報は \%https://www.kernel.org/doc/man\-pages/ に書かれている。