GetFileAttributesExA 関数 (fileapi.h)
指定したファイルまたはディレクトリの属性を取得します。
この操作をトランザクション操作として実行するには、 GetFileAttributesTransacted 関数を 使用します。
構文
BOOL GetFileAttributesExA(
[in] LPCSTR lpFileName,
[in] GET_FILEEX_INFO_LEVELS fInfoLevelId,
[out] LPVOID lpFileInformation
);
パラメーター
[in] lpFileName
ファイルまたはディレクトリの名前。
既定では、名前はMAX_PATH文字に制限されています。 この制限を 32,767 文字のワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。 詳細については、「ファイル、パス、および名前空間の名前付け」を参照してください。
ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を前もって指定しなくても、MAX_PATHの制限を削除するようにオプトインできます。 詳細については、「 名前付けファイル、パス、および名前空間 」の「パスの最大長制限」セクションを参照してください。
[in] fInfoLevelId
取得する属性情報のクラス。
このパラメーターには、 GET_FILEEX_INFO_LEVELS 列挙の次の値を指定できます。
| 値 | 説明 |
|---|---|
|
lpFileInformation パラメーターは、WIN32_FILE_ATTRIBUTE_DATA構造体です。 |
[out] lpFileInformation
属性情報を取得するバッファーへのポインター。
このバッファーに格納される属性情報の種類は、fInfoLevelId の値によって決まります。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合、戻り値はゼロ (0) になります。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
GetFileAttributes 関数は、ファイル システム属性情報を取得します。 GetFileAttributesEx は、他のファイルまたはディレクトリ属性情報のセットを取得できます。 現在、 GetFileAttributesEx は、ファイル システム属性情報のスーパーセットである一連の標準属性を取得します。
GetFileAttributesEx 関数は、マウントされたフォルダーであるディレクトリで呼び出されると、マウントされたフォルダーがディレクトリに関連付けられているボリューム内のルート ディレクトリの属性ではなく、ディレクトリの属性を返します。 関連付けられたボリュームの属性を取得するには、 GetVolumeNameForVolumeMountPoint を 呼び出して、関連付けられているボリュームの名前を取得します。 次に、 GetFileAttributesEx の呼び出しで結果の名前を使用します。 結果は、関連付けられたボリューム上のルート ディレクトリの属性です。
Windows 8とWindows Server 2012では、この関数は次のテクノロジでサポートされています。
| テクノロジ | サポートされています |
|---|---|
| サーバー メッセージ ブロック (SMB) 3.0 プロトコル | はい |
| SMB 3.0 Transparent Failover (TFO) | はい |
| スケールアウト ファイル共有を含む SMB 3.0 (SO) | はい |
| クラスター共有ボリューム ファイル システム (CsvFS) | はい |
| Resilient File System (ReFS) | はい |
シンボリック リンクの動作 — パスがシンボリック リンクを指している場合、関数はシンボリック リンクの属性を返します。
Transacted Operations
ファイルがトランザクションで変更のために開かれている場合、トランザクションがコミットされるまで、他のスレッドは変更のためにファイルを開くできません。 そのため、トランザクションスレッドが最初にファイルを開くと、トランザクションがコミットされる前にファイルを変更しようとする後続のスレッドは共有違反を受け取ります。 トランザクション以外のスレッドがトランザクションスレッドの前にファイルを変更しても、トランザクションが開こうとしたときにファイルが開いている場合、トランザクションはエラー ERROR_TRANSACTIONAL_CONFLICTを受け取ります。注意
fileapi.h ヘッダーは、GetFileAttributesEx をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows XP [デスクトップ アプリ |UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリ |UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | fileapi.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |