CBL_DIR_SCAN_START

入力パラメーター：

pattern-length

pattern-content フィールドのパターン文字列の長さ。この属性は、ハンドルと関連しているため、スキャン中は変更できない。長さが 0 の場合は、pattern-content フィールドが null で終了していることを表す。pattern-length には pattern-content フィールドの長さより小さな値を設定できるが、より大きな値を設定することはできない。

pattern-content

名前検索用の文字列。この属性は、ハンドルと関連しているため、スキャン中は変更できない。この文字列には、ファイル名を含む、または含まないディレクトリ パスの全体または一部や、ファイル名そのものを設定できる。パス内の各要素は「/」(UNIX) または 「\」Windows で区切られる。pattern-length で提供される文字列の終わりより前に null がある場合や、pattern-length が 0 に設定されている場合、その文字列は null で終了している文字列だと認識される。flags のビット 1 を設定している場合、ファイル名にワイルドカード文字を使用できる。ワイルドカード文字の「*」は任意の長さの文字列を表し、「?」は任意の 1 文字を表す。flags のビット 0 を設定している場合、プリング文字「!」をエスケープ文字として使用できる。ワイルドカードとエスケープ文字の使い方の詳細については、「コメント」の項を参照。

search-attribute

検索対象ファイルのプロパティを指定するために使用できる。この属性は、ハンドルと関連しているため、スキャン中は変更できない。有効な値は次のとおり。

値	ビット セット	意味
1	0	ファイルを検索。
2	1	ディレクトリを検索。
4	2	ファイルでもディレクトリでもないエントリを検索。

上記の指定ビットより上位のビットは無視される。ビット 0 から 2 は常に OR で結合され、例えばファイルまたはディレクトリのいずれかを検索対象にする場合はビット 0 と 1 (数値 3) を設定する。すべてのタイプのエントリを検索対象とする場合はビット 0、1 および 2 (数値 7) を設定する。

flags

次の中のいずれか 1 つの値を設定できる。

値	ビット セット	意味
1	0	pattern-content 内のエスケープ シーケンス処理を有効にする。デフォルトでは、エスケープ シーケンス処理は行われない。
2	1	pattern-content フィールドでのワイルドカード使用を可能にする。ワイルドカードはこのオプションが設定されている場合にのみ意味を成す。
4	2	返されるファイル名にパスが含まれるようにする。デフォルトでは、Windows のネイティブ ランタイム システムではパスは返されず、UNIX のネイティブ ランタイム システムとマネージ ランタイム システムではパスが返される。

上記の指定ビットより上位のビットは無視される。エスケープ文字の処理とワイルドカードの使用を共に有効にするには、ビット 0 と 1 の両方を設定 (数値 3) する。