System.SysUtils.FindFirst
Delphi
function FindFirst(const Path: string; Attr: Integer;
var F: TSearchRec): Integer;
C++
extern DELPHI_PACKAGE int __fastcall FindFirst(const System::UnicodeString Path, int Attr, TSearchRec &F);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | System.SysUtils.pas System.SysUtils.hpp |
System.SysUtils | System.SysUtils |
説明
指定されたファイル名と一連の属性を持つ最初のファイルを、指定されたディレクトリ内で探します。
FindFirst は、Path で指定されたディレクトリの中で、Path に含まれるファイル名と Attr パラメータで指定された属性とに一致する、最初のファイルを探します。 結果は F パラメータとして返されます。 この検索レコードのフィールドから必要な情報を取り出すことができまます。 FindFirst は、ファイルの検索が成功した場合には 0 を、それ以外の場合にはエラー コードを返します。
Path という定数パラメータは、ディレクトリとファイルの名前のマスクであり、ワイルドカード文字を含むことができます。 たとえば '.\test\*.*' は、test サブディレクトリ内の全ファイルを表します（Windows の場合）。
Attr パラメータでは、すべての通常のファイルの他に検索条件に含めたい、特別なファイルを指定します。 Attr パラメータを指定する際、以下のファイル属性定数から選択します。
| 定数 | 説明 |
|---|---|
|
不正なファイルであることを示します。 | |
|
読み取り専用ファイルまたは読み取り専用ディレクトリであることを示します。 | |
|
隠しファイルまたは隠しディレクトリであることを示します。 | |
|
システム ファイルまたはシステム ディレクトリであることを示します。 | |
|
（廃止予定） | |
|
ディレクトリであることを示します。 | |
|
Windows アーカイブ ファイルであることを示します。 | |
|
通常のファイルであることを示します。 | |
|
一時ファイルまたは一時ディレクトリであることを示します。 | |
|
シンボリック リンク ファイル タイプのみを指定します。 | |
|
圧縮ファイルまたは圧縮ディレクトリであることを示します。 | |
|
暗号化されたファイルまたはディレクトリであることを示します。 | |
|
システムで使用するために予約されています。 | |
|
任意のファイル タイプを指定します。 |
定数や値を追加したり（Delphi の場合）、or で結ぶことで（C++ の場合）、属性を組み合わせることができます。 たとえば、通常のファイルに加えて読み取り専用で非表示のファイルを検索条件にする場合には、Delphi では (faReadOnly + faHidden) を、C++ では (faReadOnly | faHidden) を、Attr パラメータとして渡します。 通常のファイルだけを含める場合には、Attr パラメータに 0 を渡します。
メモ： FindFirst はリソース（メモリ）を確保するため、FindClose を呼び出してそれらは解放しなければなりません。
メモ： ファイル属性定数の一部は、すべてのプラットフォームで有効というわけではありません。たとえば MAC OS の場合、faVolumeID と faArchive は正しく機能しません。