System.IOUtils.TDirectory.GetFilesEnumerator

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

class function GetFilesEnumerator(const Path, SearchPattern: string;
const SearchOption: TSearchOption; const Predicate: TFilterPredicate;
const MatchCasing: TMatchCasing = TMatchCasing.mcPlatformDefault): IEnumerable<string>; overload; static;
class function GetFilesEnumerator(const Path: string): IEnumerable<string>;
class function GetFilesEnumerator(const Path: string;
const Predicate: TFilterPredicate): IEnumerable<string>;
class function GetFilesEnumerator(const Path, SearchPattern: string): IEnumerable<string>;
class function GetFilesEnumerator(const Path, SearchPattern: string;
const Predicate: TFilterPredicate): IEnumerable<string>;
class function GetFilesEnumerator(const Path, SearchPattern: string;
const SearchOption: TSearchOption): IEnumerable<string>; overload; inline; static;
class function GetFilesEnumerator(const Path: string;
const SearchOption: TSearchOption;
const Predicate: TFilterPredicate): IEnumerable<string>; overload; inline; static;

C++

static System::DelphiInterface<System::IEnumerable__1<System::UnicodeString> > __fastcall GetFilesEnumerator(const System::UnicodeString Path, const System::UnicodeString SearchPattern, const TSearchOption SearchOption, const _di_TFilterPredicate Predicate, const TMatchCasing MatchCasing = (TMatchCasing)(0x0))/* overload */;
static System::DelphiInterface<System::IEnumerable__1<System::UnicodeString> > __fastcall GetFilesEnumerator(const System::UnicodeString Path)/* overload */;
static System::DelphiInterface<System::IEnumerable__1<System::UnicodeString> > __fastcall GetFilesEnumerator(const System::UnicodeString Path, const _di_TFilterPredicate Predicate)/* overload */;
static System::DelphiInterface<System::IEnumerable__1<System::UnicodeString> > __fastcall GetFilesEnumerator(const System::UnicodeString Path, const System::UnicodeString SearchPattern)/* overload */;
static System::DelphiInterface<System::IEnumerable__1<System::UnicodeString> > __fastcall GetFilesEnumerator(const System::UnicodeString Path, const System::UnicodeString SearchPattern, const _di_TFilterPredicate Predicate)/* overload */;
static System::DelphiInterface<System::IEnumerable__1<System::UnicodeString> > __fastcall GetFilesEnumerator(const System::UnicodeString Path, const System::UnicodeString SearchPattern, const TSearchOption SearchOption)/* overload */;
static System::DelphiInterface<System::IEnumerable__1<System::UnicodeString> > __fastcall GetFilesEnumerator(const System::UnicodeString Path, const TSearchOption SearchOption, const _di_TFilterPredicate Predicate)/* overload */;

プロパティ

種類 可視性 ソース ユニット
function public
System.IOUtils.pas
System.IOUtils.hpp
System.IOUtils TDirectory


説明

指定のディレクトリ内のファイルを列挙します。

GetFilesEnumerator を使用すると、指定されたディレクトリ内のファイルを返す、列挙オブジェクトを取得することができます。

GetFilesEnumerator メソッドには、3 つの形式があります:

  • 1 番目の形式は、ファイルを列挙したいディレクトリのパスのみを受理します。
  • 2 番目の形式には、ファイル名に一致する検索パターンが含まれています。
  • 3 番目の形式には、列挙する際に再帰モードを使用するかどうかを指定するオプションが含まれています。

すべての形式で、結果をフィルタするために使用する、任意のパラメータ TFilterPredicate パラメータを受け取れます。

次の票では、このメソッドが想定するパラメータを示します。

名前 意味

Path

ファイルを列挙しようとするディレイクトリのパス。

SearchPattern

ファイル名との一致に使用するマスク(たとえば、"*.exe" はすべての実行可能ファイルと一致します)。 SearchPattern 引数を適用している場合には、MatchesMask も使用できます。

SearchOption

ディレクトリの列挙モード。 トップレベル列挙モードを使用するか、再帰列挙モードを使用するかを指定します。

Predicate

望まない結果を除去するために使われるルーチン。


メモ: GetFilesEnumerator は、指定されたパスが無効であるか、ディレクトリが存在しない場合、例外を発生させます。

関連項目

コード例