draft/man3/fts.3

   1 .\"     $NetBSD: fts.3,v 1.13.2.1 1997/11/14 02:09:32 mrg Exp $
   2 .\"
   3 .\" Copyright (c) 1989, 1991, 1993, 1994
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\" %%%LICENSE_END
  35 .\"
  36 .\"     @(#)fts.3       8.5 (Berkeley) 4/16/94
  37 .\"
  38 .\" 2007-12-08, mtk, Converted from mdoc to man macros
  39 .\"
  40 .\"*******************************************************************
  41 .\"
  42 .\" This file was generated with po4a. Translate the source file.
  43 .\"
  44 .\"*******************************************************************
  45 .TH FTS 3 2012\-10\-25 Linux "Linux Programmer's Manual"
  46 .SH 名前
  47 fts, fts_open, fts_read, fts_children, fts_set, fts_close \- ファイル階層をたどる
  48 .SH 書式
  49 .nf
  50 \fB#include <sys/types.h>\fP
  51 \fB#include <sys/stat.h>\fP
  52 \fB#include <fts.h>\fP
  53 .sp
  54 \fBFTS *fts_open(char * const *\fP\fIpath_argv\fP\fB, int \fP\fIoptions\fP\fB, \fP
  55 \fB              int (*\fP\fIcompar\fP\fB)(const FTSENT **, const FTSENT **));\fP
  56 .sp
  57 \fBFTSENT *fts_read(FTS *\fP\fIftsp\fP\fB);\fP
  58 .sp
  59 \fBFTSENT *fts_children(FTS *\fP\fIftsp\fP\fB, int \fP\fIoptions\fP\fB);\fP
  60 .sp
  61 \fBint fts_set(FTS *\fP\fIftsp\fP\fB, FTSENT *\fP\fIf\fP\fB, int \fP\fIoptions\fP\fB);\fP
  62 .sp
  63 \fBint fts_close(FTS *\fP\fIftsp\fP\fB);\fP
  64 .fi
  65 .SH 説明
  66 fts 関数群は、ファイル階層をたどるために提供されている。 簡単に概略すると次のようになる。 \fBfts_open\fP()  関数は、他の fts
  67 関数群に渡すための、ファイル階層の「ハンドル」を返す。 \fBfts_read\fP()  関数は、ファイル階層中にある 1
  68 つのファイルを記述する構造体へのポインタを返す。 \fBfts_children\fP()  関数は、階層中のディレクトリにあるファイルを記述する構造体の
  69 リンクリストへのポインタを返す。 一般にディレクトリは、 preorder (正方向：下の階層のディレクトリをたどる前) と postorder
  70 (逆方向：下の階層のディレクトリをすべてたどった後) という、 異なる方向で 2 回たどられる。ファイルは 1 回たどられる。
  71 ディレクトリ階層を「論理的に」(シンボリックリングが指すファイルを見て) 辿ることも、 物理的に (シンボリックリンク自身を見て)
  72 辿ることも可能である。 また、階層中の移動の道筋を指示すること・ 余分なものを取り除くこと・階層の一部を再びたどることが可能である。
  73 .PP
  74 2 つの構造体がインクルードファイル \fI<fts.h>\fP で定義されている (さらに typedef されている)。 1
  75 つ目は、ファイル階層そのものを表現する \fIFTS\fP 構造体である。 2 つ目は、ファイル階層中のファイルを表現する \fIFTSENT\fP 構造体である。
  76 \fIFTSENT\fP 構造体は通常、ファイル階層中のすべてのファイルに対して返される。 この man ページでは、「ファイル」と 「\fIFTSENT\fP
  77 構造体」を一般に読み変えることができる。 \fIFTSENT\fP 構造体は、少なくとも次のようなフィールドを持っており、 以下でより詳しく説明されている。
  78 .in +4n
  79 .nf
  80
  81 typedef struct _ftsent {
  82     unsigned short fts_info;     /* FTSENT 構造体のためのフラグ */
  83     char          *fts_accpath;  /* アクセスパス */
  84     char          *fts_path;     /* ルートパス */
  85     short          fts_pathlen;  /* fts_path の長さ */
  86     char          *fts_name;     /* ファイル名 */
  87     short          fts_namelen;  /* fts_name の長さ */
  88     short          fts_level;    /* 深さ (\-1 〜 N) */
  89     int            fts_errno;    /* ファイルのエラー番号 */
  90     long           fts_number;   /* ローカルな番号 */
  91     void          *fts_pointer;  /* ローカルなアドレス番号 */
  92     struct ftsent *fts_parent;   /* 親ディレクトリ */
  93     struct ftsent *fts_link;     /* 次のファイル構造体 */
  94     struct ftsent *fts_cycle;    /* 循環している構造体 */
  95     struct stat   *fts_statp;    /* stat(2) の情報 */
  96 } FTSENT;
  97 .fi
  98 .in
  99 .PP
 100 .\" .Bl -tag -width "fts_namelen"
 101 これらのフィールドは、次のように定義されている。
 102 .TP  12
 103 \fIfts_info\fP
 104 .\" .Bl  -tag -width FTS_DEFAULT
 105 このフィールドは、返された \fIFTSENT\fP 構造体とファイルを説明する以下のフラグのいずれかを表している。 エラーのないディレクトリ
 106 (\fBFTS_D\fP), の場合は例外として、それ以外のすべてのエントリは終端である。 つまり、エントリは再びたどられることもなく、
 107 それより下の階層がたどられることもない。
 108 .RS 12
 109 .TP  12
 110 \fBFTS_D\fP
 111 preorder でたどられるディレクトリ。
 112 .TP
 113 \fBFTS_DC\fP
 114 ツリーの中で循環しているディレクトリ。 (\fIFTSENT\fP 構造体の \fIfts_cycle\fP フィールドも同様に埋められる。)
 115 .TP
 116 \fBFTS_DEFAULT\fP
 117 ファイルタイプを表現する \fIFTSENT\fP 構造体が、 \fIfts_info\fP の他のいずれかの値で明示的に説明されていない。
 118 .TP
 119 \fBFTS_DNR\fP
 120 読み込みができないディレクトリ。 これはエラーの場合の返り値であり、 何がエラーを起こしたかを示すために \fIfts_errno\fP
 121 フィールドが設定される。
 122 .TP
 123 \fBFTS_DOT\fP
 124 \fBfts_open\fP()  へのファイル名として指定されなかった "." または ".." という名前のファイル (\fBFTS_SEEDOT\fP
 125 を参照すること)。
 126 .TP
 127 \fBFTS_DP\fP
 128 postorder でたどられるディレクトリ。 \fIFTSENT\fP 構造体の内容は、preorder のときに返された状態 (つまり、
 129 \fIfts_info\fP フィールドが \fBFTS_D\fP に設定されている状態) から変更されない。
 130 .TP
 131 \fBFTS_ERR\fP
 132 これはエラーの場合の返り値であり、 \fIfts_errno\fP フィールドは、何がエラーを起こしたかを示す値に設定される。
 133 .TP
 134 \fBFTS_F\fP
 135 通常のファイル。
 136 .TP
 137 \fBFTS_NS\fP
 138 \fBstat\fP(2)  情報が得られなかったファイル。 \fIfts_statp\fP フィールドの内容は定義されない。 これはエラーの場合の返り値であり、
 139 \fIfts_errno\fP フィールドは、何がエラーを起こしたかを示す値に設定される。
 140 .TP
 141 \fBFTS_NSOK\fP
 142 \fBstat\fP(2)  情報が要求されなかったファイル。 \fIfts_statp\fP フィールドの内容は定義されない。
 143 .TP
 144 \fBFTS_SL\fP
 145 シンボリックリンク。
 146 .TP
 147 \fBFTS_SLNONE\fP
 148 .\" .El
 149 リンク先の存在しないシンボリックリンク。 \fIfts_statp\fP フィールドの内容は、シンボリックリンクそのもののファイル特性情報を参照する。
 150 .RE
 151 .TP
 152 \fIfts_accpath\fP
 153 現在のディレクトリからファイルにアクセスするためのパス。
 154 .TP
 155 \fIfts_path\fP
 156 階層をたどるときのルートからみたファイルの相対的なパス。 このパスには、 \fBfts_open\fP()  に指定したパスがプレフィックスとして含まれる。
 157 .TP
 158 \fIfts_pathlen\fP
 159 \fIfts_path\fP で参照される文字列の長さ。
 160 .TP
 161 \fIfts_name\fP
 162 ファイルの名前。
 163 .TP
 164 \fIfts_namelen\fP
 165 \fIfts_name\fP で参照される文字列の長さ。
 166 .TP
 167 \fIfts_level\fP
 168 階層をたどって、このファイルがみつかった深さ。 \-1 〜 N の数値で表される。 階層をたどるときの出発点 (ルート) の親ディレクトリを表す
 169 \fIFTSENT\fP 構造体では \-1 となる。 また、ルート自身の \fIFTSENT\fP 構造体では 0 になる。
 170 .TP
 171 \fIfts_errno\fP
 172 関数 \fBfts_children\fP()  と \fBfts_read\fP()  から返される \fIFTSENT\fP 構造体の \fIfts_info\fP
 173 フィールドが \fBFTS_DNR\fP, \fBFTS_ERR\fP, \fBFTS_NS\fP に設定されている場合、 \fIfts_errno\fP
 174 フィールドにはエラーの原因を示す外部変数 \fIerrno\fP の値が入る。 それ以外の場合、 \fIfts_errno\fP フィールドの内容は定義されない。
 175 .TP
 176 \fIfts_number\fP
 177 このフィールドは、アプリケーションプログラムから使用するために提供され、 fts 関数群では変更されない。 このフィールドは 0 で初期化される。
 178 .TP
 179 \fIfts_pointer\fP
 180 このフィールドは、アプリケーションプログラムから使用するために提供され、 fts 関数群では変更されない。 このフィールドは \fBNULL\fP
 181 で初期化される。
 182 .TP
 183 \fIfts_parent\fP
 184 現在のファイルのすぐ上の階層にあるファイル (つまり、現在のファイルがメンバーになっているディレクトリ) を参照する \fIFTSENT\fP
 185 構造体へのポインタ。 最初の出発点に対しても、親となる構造体は与えられる。 しかし、 \fIfts_level\fP, \fIfts_number\fP,
 186 \fIfts_pointer\fP フィールドのみの初期化しか保証されない。
 187 .TP
 188 \fIfts_link\fP
 189 \fBfts_children\fP()  から返される場合、 \fIfts_link\fP フィールドはディレクトリメンバーの NUL
 190 終端されたリンクリストの形式で、 次の構造体を指し示す。 それ以外の場合、 \fIfts_link\fP フィールドは定義されない。
 191 .TP
 192 \fIfts_cycle\fP
 193 2 つのディレクトリにハードリンクが張られているため、 または、シンボリックリンクがあるディレクトリを指しているために、
 194 ディレクトリが循環する階層構造を作っている場合 (\fBFTS_DC\fP を参照)、 構造体の \fIfts_cycle\fP フィールドは、階層中で現在の
 195 \fIFTSENT\fP 構造体と同じファイルを参照している \fIFTSENT\fP 構造体を指し示す。 それ以外の場合、 \fIfts_cycle\fP
 196 フィールドは定義されない。
 197 .TP
 198 \fIfts_statp\fP
 199 .\" .El
 200 このファイルの \fBstat\fP(2)  情報へのポインタ。
 201 .PP
 202 ファイル階層中のすべてのファイルのパスに対して、 ただ 1 つのバッファーが使われる。 したがって、 \fIfts_path\fP と
 203 \fIfts_accpath\fP フィールドは、 \fBfts_read\fP()  によって返された最も新しいファイルに対して「のみ」 NULL
 204 終端されることが保証される。 これらのフィールドを、他の \fIFTSENT\fP 構造体で表現されるファイルを参照するために使うには、 \fIFTSENT\fP
 205 構造体の \fIfts_pathlen\fP フィールドにある情報を使ってパスのバッファーを修正する必要がある。 これらの修正は、さらに
 206 \fBfts_read\fP()  を呼び出そうとする場合には、元に戻しておかなければならない。 \fIfts_name\fP フィールドは、常に \fBNUL\fP
 207 終端される。
 208 .SS fts_open()
 209 \fBfts_open\fP()  関数は、文字列ポインタの配列へのポインタを引き数に取る。 この文字列ポインタは、論理ファイル階層をつくる 1
 210 つ以上のパスの名前になる。 配列は、 \fBNULL\fP ポインタで終端されなければならない。
 211 .PP
 212 .\" .Bl -tag -width "FTS_PHYSICAL"
 213 多くのオプションがあり、少なくとも 1 つ (\fBFTS_LOGICAL\fP または \fBFTS_PHYSICAL\fP)  が指定されなければならない。
 214 オプションは以下の値の論理和をとって選択する。
 215 .TP  13
 216 \fBFTS_COMFOLLOW\fP
 217 このオプションは、 \fBFTS_LOGICAL\fP の指定にかかわらず、 ルートパスに指定されたシンボリックリンクをすぐにたどらせる。
 218 .TP
 219 \fBFTS_LOGICAL\fP
 220 このオプションは、 fts ルーチンにシンボリックリンクそのものではなく、 シンボリックリンクが指しているファイルの \fIFTSENT\fP
 221 構造体を返させる。 このオプションが設定された場合、 \fIFTSENT\fP 構造体がアプリケーションに返されるような
 222 シンボリックリンクのみが、存在しないファイルを参照している。 \fBFTS_LOGICAL\fP または \fBFTS_PHYSICAL\fP のどちらかを、
 223 \fBfts_open\fP()  関数に与えなければ「ならない」。
 224 .TP
 225 \fBFTS_NOCHDIR\fP
 226 パフォーマンスの最適化のため、 fts 関数群はファイル階層をたどるときディレクトリを変える。 これには、階層をたどっている間は
 227 アプリケーションがある特定のディレクトリにいるということに 依存できない、という副作用がある。 \fBFTS_NOCHDIR\fP
 228 オプションで最適化を無効にすると、 fts 関数群は現在のディレクトリを変更しない。 \fBFTS_NOCHDIR\fP が指定され、かつ
 229 \fBfts_open\fP()  の引き数として絶対パス名が与えられたとき以外、アプリケーションは、 自らカレントディレクトリを変更したり、
 230 ファイルにアクセスしたりすべきではない、という点に注意すること。
 231 .TP
 232 \fBFTS_NOSTAT\fP
 233 デフォルトでは、返された \fIFTSENT\fP 構造体は、たどられた各ファイルについてのファイル特徴情報 \fI( statp\fP フィールド) を参照する。
 234 このオプションは、 fts 関数群が \fIfts_info\fP フィールドを \fBFTS_NSOK\fP に設定し \fIstatp\fP
 235 の内容を定義されないままにすることを許すことにより、 パフォーマンスの最適化に必要なものを緩和する。
 236 .TP
 237 \fBFTS_PHYSICAL\fP
 238 このオプションは、 fts ルーチンにシンボリックリンクが指しているファイルではなく、 シンボリックリンク自身の \fIFTSENT\fP 構造体を返させる。
 239 このオプションが設定されると、階層中のすべてのシンボリックリンクの \fIFTSENT\fP 構造体がアプリケーションに返される。
 240 \fBFTS_LOGICAL\fP または \fBFTS_PHYSICAL\fP のどちらかを \fBfts_open\fP()  関数に与えなければ「ならない」。
 241 .TP
 242 \fBFTS_SEEDOT\fP
 243 デフォルトでは、 \fBfts_open\fP()  のパス引き数として指定されない限り、ファイル階層中にある "." または ".."
 244 という名前のファイルは無視される。 このオプションは、 fts ルーチンにこれらのファイルの \fIFTSENT\fP 構造体を返させる。
 245 .TP
 246 \fBFTS_XDEV\fP
 247 .\" .El
 248 このオプションは、 fts が下り始めのファイルとは異なるデバイス番号を持っている ディレクトリに下りるのを阻止する。
 249 .PP
 250 引き数 \fBcompar\fP()  は、階層をたどる順番を決めるのに使われるユーザー定義関数を指定する。 この関数は、引き数として \fIFTSENT\fP
 251 構造体のポインタのポインタを 2 つとり、 1 番目の引き数で参照されているファイルが 2 番目の引き数で参照されているファイルより
 252 前にある場合は負の値・同じ場合はゼロ・後にある場合は正の値を 返さなければならない。 \fIFTSENT\fP 構造体の \fIfts_accpath\fP,
 253 \fIfts_path\fP, \fIfts_pathlen\fP フィールドは、この比較に「絶対」使ってはいけない。 \fIfts_info\fP フィールドが
 254 \fBFTS_NS\fP または \fBFTS_NSOK\fP に設定される場合、 \fIfts_statp\fP フィールドはこれらのどちらでもない。
 255 \fBcompar\fP()  引き数が \fBNULL\fP の場合、ディレクトリをたどる順番は、ルートパスについては \fIpath_argv\fP
 256 のなかでリストされた順番で、 その他のファイルについてはディレクトリ内でリストされた順番となる。
 257 .SS fts_read()
 258 \fBfts_read\fP()  関数は、階層中のファイルを記述する \fIFTSENT\fP 構造体へのポインタを返す。 (読み込み可能で、循環していない)
 259 ディレクトリは、 1 回は preorder で、もう 1 回は postorder で、少なくとも 2 回たどられる。 他のファイルは、少なくとも 1
 260 回たどられる。 (ディレクトリ間のハードリンクによって 循環やシンボリックリンクへのシンボリックリンクが起こらない場合、 ファイルは 2
 261 回以上、ディレクトリは 3 回以上たどられる。)
 262 .PP
 263 階層中のすべてのメンバーが返された場合、 \fBfts_read\fP()  は \fBNULL\fP を返し、外部変数 \fIerrno\fP を 0 にする。
 264 階層中のファイルに関係しないエラーが起こった場合、 \fBfts_read\fP()  は \fBNULL\fP を返し、 \fIerrno\fP
 265 をエラーに対応した値にする。 階層中のファイルに関係したエラーが起こった場合、 \fIFTSENT\fP 構造体へのポインタが返され、 \fIerrno\fP
 266 は設定される場合と設定されない場合がある (\fIfts_info\fP を参照すること)。
 267 .PP
 268 \fBfts_read\fP()  によって返される \fIFTSENT\fP 構造体は、同じファイル階層ストリームへの \fBfts_close\fP()
 269 の呼出しの後に上書きされる。 また、同じファイル階層ストリームへの \fBfts_read\fP()
 270 の呼出しの後でも、構造体がディレクトリを表現していない限り上書きされる。 この場合、 \fBfts_read\fP()  関数によって postorder で
 271 \fIFTSENT\fP 構造体が返された後、 \fBfts_read\fP()  の呼出しがあるまで、 これらの構造体は上書きされない。
 272 .SS fts_children()
 273 \fBfts_children\fP()  関数は、 \fIFTSENT\fP 構造体へのポインタを返す。 この構造体は、( \fBfts_read\fP()
 274 で最も新しく返された \fIFTSENT\fP 構造体で表現されるディレクトリにあるファイルの)  NUL 終端されたリンクリストの最初のエントリを記述する。
 275 このリストは、 \fIFTSENT\fP 構造体の \fIfts_link\fP フィールドを使ってリンクされ、
 276 ユーザー指定の比較関数がある場合は、それで順序づけられる。 \fBfts_children\fP()  の呼出しを繰り返すことで、
 277 このリンクリストは再生成される。
 278 .PP
 279 特別な場合として、 \fBfts_read\fP()  がファイル階層について呼ばれていない場合、 \fBfts_children\fP()  は
 280 \fBfts_open\fP()  に指定された論理ディレクトリ (つまり、 \fBfts_open\fP()  に指定された引き数)
 281 の中にあるファイルへのポインタを返す。 それ以外の場合で、 \fBfts_read\fP()  によって最も新しく返された \fIFTSENT\fP 構造体が
 282 preorder でたどられたディレクトリでない場合や 何も含んでいないディレクトリの場合は、 \fBfts_children\fP()  は \fBNULL\fP
 283 を返し、 \fIerrno\fP を 0 にする。 エラーが起こった場合、 \fBfts_children\fP()  は \fBNULL\fP を返し、
 284 \fIerrno\fP をエラーに対応した値にする。
 285 .PP
 286 \fBfts_children\fP()  によって返される \fIFTSENT\fP 構造体は、同じファイル階層ストリームへの
 287 \fBfts_children\fP(), \fBfts_close\fP(), \fBfts_read\fP()  の呼出しの後に上書きされる場合がある。
 288 .PP
 289 .\" .Bl -tag -width FTS_NAMEONLY
 290 \fIoption\fP は、次の値に設定できる。
 291 .TP  13
 292 \fBFTS_NAMEONLY\fP
 293 .\" .El
 294 ファイル名のみが必要とされている。 返された構造体のリンクリストの \fIfts_name\fP, \fIfts_namelen\fP フィールド以外の
 295 すべてのフィールドの内容は定義されない。
 296 .SS fts_set()
 297 .\" .Bl -tag -width FTS_PHYSICAL
 298 関数 \fBfts_set\fP()  は、ユーザーアプリケーションが ストリーム \fIftsp\fP のファイル \fIf\fP
 299 について更なる処理を決定すること許す。 \fBfts_set\fP()  関数は、成功した場合は 0 を、エラーが起こった場合は \-1 を返す。
 300 \fIoption\fP は、次の値のいずれか 1 つに設定されなければならない。
 301 .TP  13
 302 \fBFTS_AGAIN\fP
 303 ファイルを再びたどる。すべてのファイルタイプが再びたどられる。 次の \fBfts_read\fP()  の呼出しにより、参照されているファイルが返される。
 304 構造体の \fIfts_stat\fP, \fIfts_info\fP フィールドはこの時に初期化されるが、他のフィールドは変更されない。 このオプションは、
 305 \fBfts_read\fP()  によって最も新しく返されたファイルについてのみ意味を持つ。 通常は、postorder
 306 でディレクトリをたどる場合に使用し、 その下の階層と同様に、 ディレクトリを (preorder と postorder の両方で) 再びたどらせる。
 307 .TP
 308 \fBFTS_FOLLOW\fP
 309 参照されてるファイルは、シンボリックリンクでなければならない。 参照されているファイルが \fBfts_read\fP()
 310 によって最も新しく返されたものである場合、次の \fBfts_read\fP()  の呼出しでは、シンボリックリンクそのものではなく、
 311 シンボリックリンクが指している先を反映するように \fIfts_info\fP, \fIfts_statp\fP を再び初期化したファイルが返される。 ファイルが
 312 \fBfts_children\fP()  によって最も新しく返されたものの 1 つである場合、 \fBfts_read\fP()  によって返されたとき、構造体の
 313 \fIfts_info\fP, \fIfts_statp\fP フィールドは、シンボリックリンクそのものではなく、 シンボリックリンクが指している先を反映する。
 314 どちらの場合でも、シンボリックリンクが指している先がないときは、 返された構造体のフィールドは変更されず、 \fIfts_info\fP フィールドが
 315 \fBFTS_SLNONE\fP に設定される。
 316 .IP
 317 リンク先がディレクトリの場合、 ファイルが preorder で返された後、下の階層のすべてファイルが返され、 その後で postorder
 318 で返される。
 319 .TP
 320 \fBFTS_SKIP\fP
 321 .\" .El
 322 このファイルの下の階層はたどられない。 このファイルは、 \fBfts_children\fP()  または \fBfts_read\fP()
 323 のどちらかによって最も新しく返されたものの 1 つである。
 324 .SS fts_close()
 325 \fBfts_close\fP()  関数は、ファイル階層ストリーム \fIftsp\fP を閉じる。そして、現在のディレクトリを \fIftsp\fP を開くために
 326 \fBfts_open\fP()  が呼ばれたディレクトリに復元する。 \fBfts_close\fP()  関数は、成功した場合は 0 を、エラーが起こった場合は
 327 \-1 を返す。
 328 .SH エラー
 329 関数 \fBfts_open\fP()  が失敗した場合、 \fIerrno\fP は、ライブラリ関数 \fBopen\fP(2)  と \fBmalloc\fP(3)
 330 に対して指定されるエラーに設定される。
 331 .PP
 332 関数 \fBfts_close\fP()  が失敗した場合、 \fIerrno\fP は、ライブラリ関数 \fBchdir\fP(2)  と \fBclose\fP(2)
 333 に対して指定されるエラーに設定される。
 334 .PP
 335 関数 \fBfts_read\fP()  と \fBfts_children\fP()  が失敗した場合、 \fIerrno\fP は、ライブラリ関数
 336 \fBchdir\fP(2), \fBmalloc\fP(3), \fBopendir\fP(3), \fBreaddir\fP(3), \fBstat\fP(2)
 337 に対して指定されるエラーに設定される。
 338 .PP
 339 更に、 \fBfts_children\fP(), \fBfts_open\fP(), \fBfts_set\fP()  が失敗した場合、 \fIerrno\fP
 340 が次の値にされる。
 341 .TP
 342 \fBEINVAL\fP
 343 オプションが無効であった。
 344 .SH バージョン
 345 これらの関数は、Linux では glibc2 から使用可能である。
 346 .SH 準拠
 347 .\" The following statement is years old, and seems no closer to
 348 .\" being true -- mtk
 349 .\" The
 350 .\" .I fts
 351 .\" utility is expected to be included in a future
 352 .\" POSIX.1
 353 .\" revision.
 354 4.4BSD.
 355 .SH 関連項目
 356 \fBfind\fP(1), \fBchdir\fP(2), \fBstat\fP(2), \fBftw\fP(3), \fBqsort\fP(3)
 357 .SH この文書について
 358 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 359 である。プロジェクトの説明とバグ報告に関する情報は
 360 http://www.kernel.org/doc/man\-pages/ に書かれている。