OSDN Git Service

Update release for LDP 3.67
[linuxjm/LDP_man-pages.git] / release / 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 .\"
46 .\" Japanese Version Copyright (c) 2000 Yuichi SATO
47 .\"         all rights reserved.
48 .\" Translated Tue Jul 11 19:02:58 JST 2000
49 .\"         by Yuichi SATO <sato@complex.eng.hokudai.ac.jp>
50 .\"
51 .TH FTS 3 2014\-03\-18 Linux "Linux Programmer's Manual"
52 .SH 名前
53 fts, fts_open, fts_read, fts_children, fts_set, fts_close \- ファイル階層をたどる
54 .SH 書式
55 .nf
56 \fB#include <sys/types.h>\fP
57 \fB#include <sys/stat.h>\fP
58 \fB#include <fts.h>\fP
59 .sp
60 \fBFTS *fts_open(char * const *\fP\fIpath_argv\fP\fB, int \fP\fIoptions\fP\fB, \fP
61 \fB              int (*\fP\fIcompar\fP\fB)(const FTSENT **, const FTSENT **));\fP
62 .sp
63 \fBFTSENT *fts_read(FTS *\fP\fIftsp\fP\fB);\fP
64 .sp
65 \fBFTSENT *fts_children(FTS *\fP\fIftsp\fP\fB, int \fP\fIoptions\fP\fB);\fP
66 .sp
67 \fBint fts_set(FTS *\fP\fIftsp\fP\fB, FTSENT *\fP\fIf\fP\fB, int \fP\fIoptions\fP\fB);\fP
68 .sp
69 \fBint fts_close(FTS *\fP\fIftsp\fP\fB);\fP
70 .fi
71 .SH 説明
72 fts 関数群は、ファイル階層をたどるために提供されている。 簡単に概略すると次のようになる。 \fBfts_open\fP()  関数は、他の fts
73 関数群に渡すための、ファイル階層の「ハンドル」を返す。 \fBfts_read\fP()  関数は、ファイル階層中にある 1
74 つのファイルを記述する構造体へのポインタを返す。 \fBfts_children\fP()  関数は、階層中のディレクトリにあるファイルを記述する構造体の
75 リンクリストへのポインタを返す。 一般にディレクトリは、 preorder (正方向:下の階層のディレクトリをたどる前) と postorder
76 (逆方向:下の階層のディレクトリをすべてたどった後) という、 異なる方向で 2 回たどられる。ファイルは 1 回たどられる。
77 ディレクトリ階層を「論理的に」(シンボリックリングが指すファイルを見て) 辿ることも、 物理的に (シンボリックリンク自身を見て)
78 辿ることも可能である。 また、階層中の移動の道筋を指示すること・ 余分なものを取り除くこと・階層の一部を再びたどることが可能である。
79 .PP
80 2 つの構造体がインクルードファイル \fI<fts.h>\fP で定義されている (さらに typedef されている)。 1
81 つ目は、ファイル階層そのものを表現する \fIFTS\fP 構造体である。 2 つ目は、ファイル階層中のファイルを表現する \fIFTSENT\fP 構造体である。
82 \fIFTSENT\fP 構造体は通常、ファイル階層中のすべてのファイルに対して返される。 この man ページでは、「ファイル」と 「\fIFTSENT\fP
83 構造体」を一般に読み変えることができる。 \fIFTSENT\fP 構造体は、少なくとも次のようなフィールドを持っており、 以下でより詳しく説明されている。
84 .in +4n
85 .nf
86
87 typedef struct _ftsent {
88     unsigned short fts_info;     /* FTSENT 構造体のためのフラグ */
89     char          *fts_accpath;  /* アクセスパス */
90     char          *fts_path;     /* ルートパス */
91     short          fts_pathlen;  /* fts_path の長さ */
92     char          *fts_name;     /* ファイル名 */
93     short          fts_namelen;  /* fts_name の長さ */
94     short          fts_level;    /* 深さ (\-1 〜 N) */
95     int            fts_errno;    /* ファイルのエラー番号 */
96     long           fts_number;   /* ローカルな番号 */
97     void          *fts_pointer;  /* ローカルなアドレス番号 */
98     struct ftsent *fts_parent;   /* 親ディレクトリ */
99     struct ftsent *fts_link;     /* 次のファイル構造体 */
100     struct ftsent *fts_cycle;    /* 循環している構造体 */
101     struct stat   *fts_statp;    /* stat(2) の情報 */
102 } FTSENT;
103 .fi
104 .in
105 .PP
106 .\" .Bl -tag -width "fts_namelen"
107 これらのフィールドは、次のように定義されている。
108 .TP  12
109 \fIfts_info\fP
110 .\" .Bl  -tag -width FTS_DEFAULT
111 このフィールドは、返された \fIFTSENT\fP 構造体とファイルを説明する以下のフラグのいずれかを表している。 エラーのないディレクトリ
112 (\fBFTS_D\fP), の場合は例外として、それ以外のすべてのエントリは終端である。 つまり、エントリは再びたどられることもなく、
113 それより下の階層がたどられることもない。
114 .RS 12
115 .TP  12
116 \fBFTS_D\fP
117 preorder でたどられるディレクトリ。
118 .TP 
119 \fBFTS_DC\fP
120 ツリーの中で循環しているディレクトリ。 (\fIFTSENT\fP 構造体の \fIfts_cycle\fP フィールドも同様に埋められる。)
121 .TP 
122 \fBFTS_DEFAULT\fP
123 ファイルタイプを表現する \fIFTSENT\fP 構造体が、 \fIfts_info\fP の他のいずれかの値で明示的に説明されていない。
124 .TP 
125 \fBFTS_DNR\fP
126 読み込みができないディレクトリ。 これはエラーの場合の返り値であり、 何がエラーを起こしたかを示すために \fIfts_errno\fP
127 フィールドが設定される。
128 .TP 
129 \fBFTS_DOT\fP
130 \fBfts_open\fP()  へのファイル名として指定されなかった "." または ".." という名前のファイル (\fBFTS_SEEDOT\fP
131 を参照すること)。
132 .TP 
133 \fBFTS_DP\fP
134 postorder でたどられるディレクトリ。 \fIFTSENT\fP 構造体の内容は、preorder のときに返された状態 (つまり、
135 \fIfts_info\fP フィールドが \fBFTS_D\fP に設定されている状態) から変更されない。
136 .TP 
137 \fBFTS_ERR\fP
138 これはエラーの場合の返り値であり、 \fIfts_errno\fP フィールドは、何がエラーを起こしたかを示す値に設定される。
139 .TP 
140 \fBFTS_F\fP
141 通常のファイル。
142 .TP 
143 \fBFTS_NS\fP
144 \fBstat\fP(2)  情報が得られなかったファイル。 \fIfts_statp\fP フィールドの内容は定義されない。 これはエラーの場合の返り値であり、
145 \fIfts_errno\fP フィールドは、何がエラーを起こしたかを示す値に設定される。
146 .TP 
147 \fBFTS_NSOK\fP
148 \fBstat\fP(2)  情報が要求されなかったファイル。 \fIfts_statp\fP フィールドの内容は定義されない。
149 .TP 
150 \fBFTS_SL\fP
151 シンボリックリンク。
152 .TP 
153 \fBFTS_SLNONE\fP
154 .\" .El
155 リンク先の存在しないシンボリックリンク。 \fIfts_statp\fP フィールドの内容は、シンボリックリンクそのもののファイル特性情報を参照する。
156 .RE
157 .TP 
158 \fIfts_accpath\fP
159 現在のディレクトリからファイルにアクセスするためのパス。
160 .TP 
161 \fIfts_path\fP
162 階層をたどるときのルートからみたファイルの相対的なパス。 このパスには、 \fBfts_open\fP()  に指定したパスがプレフィックスとして含まれる。
163 .TP 
164 \fIfts_pathlen\fP
165 \fIfts_path\fP で参照される文字列の長さ。
166 .TP 
167 \fIfts_name\fP
168 ファイルの名前。
169 .TP 
170 \fIfts_namelen\fP
171 \fIfts_name\fP で参照される文字列の長さ。
172 .TP 
173 \fIfts_level\fP
174 階層をたどって、このファイルがみつかった深さ。 \-1 〜 N の数値で表される。 階層をたどるときの出発点 (ルート) の親ディレクトリを表す
175 \fIFTSENT\fP 構造体では \-1 となる。 また、ルート自身の \fIFTSENT\fP 構造体では 0 になる。
176 .TP 
177 \fIfts_errno\fP
178 関数 \fBfts_children\fP()  と \fBfts_read\fP()  から返される \fIFTSENT\fP 構造体の \fIfts_info\fP
179 フィールドが \fBFTS_DNR\fP, \fBFTS_ERR\fP, \fBFTS_NS\fP に設定されている場合、 \fIfts_errno\fP
180 フィールドにはエラーの原因を示す外部変数 \fIerrno\fP の値が入る。 それ以外の場合、 \fIfts_errno\fP フィールドの内容は定義されない。
181 .TP 
182 \fIfts_number\fP
183 このフィールドは、アプリケーションプログラムから使用するために提供され、 fts 関数群では変更されない。 このフィールドは 0 で初期化される。
184 .TP 
185 \fIfts_pointer\fP
186 このフィールドは、アプリケーションプログラムから使用するために提供され、 fts 関数群では変更されない。 このフィールドは \fBNULL\fP
187 で初期化される。
188 .TP 
189 \fIfts_parent\fP
190 現在のファイルのすぐ上の階層にあるファイル (つまり、現在のファイルがメンバーになっているディレクトリ) を参照する \fIFTSENT\fP
191 構造体へのポインタ。 最初の出発点に対しても、親となる構造体は与えられる。 しかし、 \fIfts_level\fP, \fIfts_number\fP,
192 \fIfts_pointer\fP フィールドのみの初期化しか保証されない。
193 .TP 
194 \fIfts_link\fP
195 \fBfts_children\fP()  から返される場合、 \fIfts_link\fP フィールドはディレクトリメンバーのヌル終端されたリンクリストの形式で、
196 次の構造体を指し示す。 それ以外の場合、 \fIfts_link\fP フィールドは定義されない。
197 .TP 
198 \fIfts_cycle\fP
199 2 つのディレクトリにハードリンクが張られているため、 または、シンボリックリンクがあるディレクトリを指しているために、
200 ディレクトリが循環する階層構造を作っている場合 (\fBFTS_DC\fP を参照)、 構造体の \fIfts_cycle\fP フィールドは、階層中で現在の
201 \fIFTSENT\fP 構造体と同じファイルを参照している \fIFTSENT\fP 構造体を指し示す。 それ以外の場合、 \fIfts_cycle\fP
202 フィールドは定義されない。
203 .TP 
204 \fIfts_statp\fP
205 .\" .El
206 このファイルの \fBstat\fP(2)  情報へのポインタ。
207 .PP
208 ファイル階層中のすべてのファイルのパスに対して、 ただ 1 つのバッファーが使われる。 したがって、 \fIfts_path\fP と
209 \fIfts_accpath\fP フィールドは、 \fBfts_read\fP()
210 によって返された最も新しいファイルに対して「のみ」ヌル終端されることが保証される。 これらのフィールドを、他の \fIFTSENT\fP
211 構造体で表現されるファイルを参照するために使うには、 \fIFTSENT\fP 構造体の \fIfts_pathlen\fP
212 フィールドにある情報を使ってパスのバッファーを修正する必要がある。 これらの修正は、さらに \fBfts_read\fP()
213 を呼び出そうとする場合には、元に戻しておかなければならない。 \fIfts_name\fP フィールドは、常に \fBNUL\fP 終端される。
214 .SS fts_open()
215 \fBfts_open\fP()  関数は、文字列ポインタの配列へのポインタを引き数に取る。 この文字列ポインタは、論理ファイル階層をつくる 1
216 つ以上のパスの名前になる。 配列は、 null ポインタで終端されなければならない。
217 .PP
218 .\" .Bl -tag -width "FTS_PHYSICAL"
219 多くのオプションがあり、少なくとも 1 つ (\fBFTS_LOGICAL\fP または \fBFTS_PHYSICAL\fP)  が指定されなければならない。
220 オプションは以下の値の論理和をとって選択する。
221 .TP  13
222 \fBFTS_COMFOLLOW\fP
223 このオプションは、 \fBFTS_LOGICAL\fP の指定にかかわらず、 ルートパスに指定されたシンボリックリンクをすぐにたどらせる。
224 .TP 
225 \fBFTS_LOGICAL\fP
226 このオプションは、 fts ルーチンにシンボリックリンクそのものではなく、 シンボリックリンクが指しているファイルの \fIFTSENT\fP
227 構造体を返させる。 このオプションが設定された場合、 \fIFTSENT\fP 構造体がアプリケーションに返されるような
228 シンボリックリンクのみが、存在しないファイルを参照している。 \fBFTS_LOGICAL\fP または \fBFTS_PHYSICAL\fP のどちらかを、
229 \fBfts_open\fP()  関数に与えなければ「ならない」。
230 .TP 
231 \fBFTS_NOCHDIR\fP
232 パフォーマンスの最適化のため、 fts 関数群はファイル階層をたどるときディレクトリを変える。 これには、階層をたどっている間は
233 アプリケーションがある特定のディレクトリにいるということに 依存できない、という副作用がある。 \fBFTS_NOCHDIR\fP
234 オプションで最適化を無効にすると、 fts 関数群は現在のディレクトリを変更しない。 \fBFTS_NOCHDIR\fP が指定され、かつ
235 \fBfts_open\fP()  の引き数として絶対パス名が与えられたとき以外、アプリケーションは、 自らカレントディレクトリを変更したり、
236 ファイルにアクセスしたりすべきではない、という点に注意すること。
237 .TP 
238 \fBFTS_NOSTAT\fP
239 デフォルトでは、返された \fIFTSENT\fP 構造体は、たどられた各ファイルについてのファイル特徴情報 \fI( statp\fP フィールド) を参照する。
240 このオプションは、 fts 関数群が \fIfts_info\fP フィールドを \fBFTS_NSOK\fP に設定し \fIstatp\fP
241 の内容を定義されないままにすることを許すことにより、 パフォーマンスの最適化に必要なものを緩和する。
242 .TP 
243 \fBFTS_PHYSICAL\fP
244 このオプションは、 fts ルーチンにシンボリックリンクが指しているファイルではなく、 シンボリックリンク自身の \fIFTSENT\fP 構造体を返させる。
245 このオプションが設定されると、階層中のすべてのシンボリックリンクの \fIFTSENT\fP 構造体がアプリケーションに返される。
246 \fBFTS_LOGICAL\fP または \fBFTS_PHYSICAL\fP のどちらかを \fBfts_open\fP()  関数に与えなければ「ならない」。
247 .TP 
248 \fBFTS_SEEDOT\fP
249 デフォルトでは、 \fBfts_open\fP()  のパス引き数として指定されない限り、ファイル階層中にある "." または ".."
250 という名前のファイルは無視される。 このオプションは、 fts ルーチンにこれらのファイルの \fIFTSENT\fP 構造体を返させる。
251 .TP 
252 \fBFTS_XDEV\fP
253 .\" .El
254 このオプションは、 fts が下り始めのファイルとは異なるデバイス番号を持っている ディレクトリに下りるのを阻止する。
255 .PP
256 引き数 \fBcompar\fP()  は、階層をたどる順番を決めるのに使われるユーザー定義関数を指定する。 この関数は、引き数として \fIFTSENT\fP
257 構造体のポインタのポインタを 2 つとり、 1 番目の引き数で参照されているファイルが 2 番目の引き数で参照されているファイルより
258 前にある場合は負の値・同じ場合はゼロ・後にある場合は正の値を 返さなければならない。 \fIFTSENT\fP 構造体の \fIfts_accpath\fP,
259 \fIfts_path\fP, \fIfts_pathlen\fP フィールドは、この比較に「絶対」使ってはいけない。 \fIfts_info\fP フィールドが
260 \fBFTS_NS\fP または \fBFTS_NSOK\fP に設定される場合、 \fIfts_statp\fP フィールドはこれらのどちらでもない。
261 \fBcompar\fP()  引き数が \fBNULL\fP の場合、ディレクトリをたどる順番は、ルートパスについては \fIpath_argv\fP
262 のなかでリストされた順番で、 その他のファイルについてはディレクトリ内でリストされた順番となる。
263 .SS fts_read()
264 \fBfts_read\fP()  関数は、階層中のファイルを記述する \fIFTSENT\fP 構造体へのポインタを返す。 (読み込み可能で、循環していない)
265 ディレクトリは、 1 回は preorder で、もう 1 回は postorder で、少なくとも 2 回たどられる。 他のファイルは、少なくとも 1
266 回たどられる。 (ディレクトリ間のハードリンクによって 循環やシンボリックリンクへのシンボリックリンクが起こらない場合、 ファイルは 2
267 回以上、ディレクトリは 3 回以上たどられる。)
268 .PP
269 階層中のすべてのメンバーが返された場合、 \fBfts_read\fP()  は \fBNULL\fP を返し、外部変数 \fIerrno\fP を 0 にする。
270 階層中のファイルに関係しないエラーが起こった場合、 \fBfts_read\fP()  は \fBNULL\fP を返し、 \fIerrno\fP
271 をエラーに対応した値にする。 階層中のファイルに関係したエラーが起こった場合、 \fIFTSENT\fP 構造体へのポインタが返され、 \fIerrno\fP
272 は設定される場合と設定されない場合がある (\fIfts_info\fP を参照すること)。
273 .PP
274 \fBfts_read\fP()  によって返される \fIFTSENT\fP 構造体は、同じファイル階層ストリームへの \fBfts_close\fP()
275 の呼出しの後に上書きされる。 また、同じファイル階層ストリームへの \fBfts_read\fP()
276 の呼出しの後でも、構造体がディレクトリを表現していない限り上書きされる。 この場合、 \fBfts_read\fP()  関数によって postorder で
277 \fIFTSENT\fP 構造体が返された後、 \fBfts_read\fP()  の呼出しがあるまで、 これらの構造体は上書きされない。
278 .SS fts_children()
279 \fBfts_children\fP()  関数は、 \fIFTSENT\fP 構造体へのポインタを返す。 この構造体は、( \fBfts_read\fP()
280 で最も新しく返された \fIFTSENT\fP 構造体で表現されるディレクトリにあるファイルの) ヌル終端されたリンクリストの最初のエントリを記述する。
281 このリストは、 \fIFTSENT\fP 構造体の \fIfts_link\fP フィールドを使ってリンクされ、
282 ユーザー指定の比較関数がある場合は、それで順序づけられる。 \fBfts_children\fP()  の呼出しを繰り返すことで、
283 このリンクリストは再生成される。
284 .PP
285 特別な場合として、 \fBfts_read\fP()  がファイル階層について呼ばれていない場合、 \fBfts_children\fP()  は
286 \fBfts_open\fP()  に指定された論理ディレクトリ (つまり、 \fBfts_open\fP()  に指定された引き数)
287 の中にあるファイルへのポインタを返す。 それ以外の場合で、 \fBfts_read\fP()  によって最も新しく返された \fIFTSENT\fP 構造体が
288 preorder でたどられたディレクトリでない場合や 何も含んでいないディレクトリの場合は、 \fBfts_children\fP()  は \fBNULL\fP
289 を返し、 \fIerrno\fP を 0 にする。 エラーが起こった場合、 \fBfts_children\fP()  は \fBNULL\fP を返し、
290 \fIerrno\fP をエラーに対応した値にする。
291 .PP
292 \fBfts_children\fP()  によって返される \fIFTSENT\fP 構造体は、同じファイル階層ストリームへの
293 \fBfts_children\fP(), \fBfts_close\fP(), \fBfts_read\fP()  の呼出しの後に上書きされる場合がある。
294 .PP
295 .\" .Bl -tag -width FTS_NAMEONLY
296 \fIoption\fP は、次の値に設定できる。
297 .TP  13
298 \fBFTS_NAMEONLY\fP
299 .\" .El
300 ファイル名のみが必要とされている。 返された構造体のリンクリストの \fIfts_name\fP, \fIfts_namelen\fP フィールド以外の
301 すべてのフィールドの内容は定義されない。
302 .SS fts_set()
303 .\" .Bl -tag -width FTS_PHYSICAL
304 関数 \fBfts_set\fP()  は、ユーザーアプリケーションが ストリーム \fIftsp\fP のファイル \fIf\fP
305 について更なる処理を決定すること許す。 \fBfts_set\fP()  関数は、成功した場合は 0 を、エラーが起こった場合は \-1 を返す。
306 \fIoption\fP は、次の値のいずれか 1 つに設定されなければならない。
307 .TP  13
308 \fBFTS_AGAIN\fP
309 ファイルを再びたどる。すべてのファイルタイプが再びたどられる。 次の \fBfts_read\fP()  の呼出しにより、参照されているファイルが返される。
310 構造体の \fIfts_stat\fP, \fIfts_info\fP フィールドはこの時に初期化されるが、他のフィールドは変更されない。 このオプションは、
311 \fBfts_read\fP()  によって最も新しく返されたファイルについてのみ意味を持つ。 通常は、postorder
312 でディレクトリをたどる場合に使用し、 その下の階層と同様に、 ディレクトリを (preorder と postorder の両方で) 再びたどらせる。
313 .TP 
314 \fBFTS_FOLLOW\fP
315 参照されてるファイルは、シンボリックリンクでなければならない。 参照されているファイルが \fBfts_read\fP()
316 によって最も新しく返されたものである場合、次の \fBfts_read\fP()  の呼出しでは、シンボリックリンクそのものではなく、
317 シンボリックリンクが指している先を反映するように \fIfts_info\fP, \fIfts_statp\fP を再び初期化したファイルが返される。 ファイルが
318 \fBfts_children\fP()  によって最も新しく返されたものの 1 つである場合、 \fBfts_read\fP()  によって返されたとき、構造体の
319 \fIfts_info\fP, \fIfts_statp\fP フィールドは、シンボリックリンクそのものではなく、 シンボリックリンクが指している先を反映する。
320 どちらの場合でも、シンボリックリンクが指している先がないときは、 返された構造体のフィールドは変更されず、 \fIfts_info\fP フィールドが
321 \fBFTS_SLNONE\fP に設定される。
322 .IP
323 リンク先がディレクトリの場合、 ファイルが preorder で返された後、下の階層のすべてファイルが返され、 その後で postorder
324 で返される。
325 .TP 
326 \fBFTS_SKIP\fP
327 .\" .El
328 このファイルの下の階層はたどられない。 このファイルは、 \fBfts_children\fP()  または \fBfts_read\fP()
329 のどちらかによって最も新しく返されたものの 1 つである。
330 .SS fts_close()
331 \fBfts_close\fP()  関数は、ファイル階層ストリーム \fIftsp\fP を閉じる。そして、現在のディレクトリを \fIftsp\fP を開くために
332 \fBfts_open\fP()  が呼ばれたディレクトリに復元する。 \fBfts_close\fP()  関数は、成功した場合は 0 を、エラーが起こった場合は
333 \-1 を返す。
334 .SH エラー
335 関数 \fBfts_open\fP()  が失敗した場合、 \fIerrno\fP は、ライブラリ関数 \fBopen\fP(2)  と \fBmalloc\fP(3)
336 に対して指定されるエラーに設定される。
337 .PP
338 関数 \fBfts_close\fP()  が失敗した場合、 \fIerrno\fP は、ライブラリ関数 \fBchdir\fP(2)  と \fBclose\fP(2)
339 に対して指定されるエラーに設定される。
340 .PP
341 関数 \fBfts_read\fP()  と \fBfts_children\fP()  が失敗した場合、 \fIerrno\fP は、ライブラリ関数
342 \fBchdir\fP(2), \fBmalloc\fP(3), \fBopendir\fP(3), \fBreaddir\fP(3), \fBstat\fP(2)
343 に対して指定されるエラーに設定される。
344 .PP
345 更に、 \fBfts_children\fP(), \fBfts_open\fP(), \fBfts_set\fP()  が失敗した場合、 \fIerrno\fP
346 が次の値にされる。
347 .TP 
348 \fBEINVAL\fP
349 オプションが無効であった。
350 .SH バージョン
351 これらの関数は、Linux では glibc2 から使用可能である。
352 .SH 準拠
353 4.4BSD.
354 .SH バグ
355 .\" https://sourceware.org/bugzilla/show_bug.cgi?id=15838
356 .\" https://sourceware.org/bugzilla/show_bug.cgi?id=11460
357 .\" The following statement is years old, and seems no closer to
358 .\" being true -- mtk
359 .\" The
360 .\" .I fts
361 .\" utility is expected to be included in a future
362 .\" POSIX.1
363 .\" revision.
364 このマニュアルページで説明した API はいずれも、 LFS API を使うプログラムをコンパイルする場合
365 (例えば、\fI\-D_FILE_OFFSET_BITS=64\fP でコンパイルする場合など)、安全ではない。
366 .SH 関連項目
367 \fBfind\fP(1), \fBchdir\fP(2), \fBstat\fP(2), \fBftw\fP(3), \fBqsort\fP(3)
368 .SH この文書について
369 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.67 の一部
370 である。プロジェクトの説明とバグ報告に関する情報は
371 http://www.kernel.org/doc/man\-pages/ に書かれている。