GetFileAttributesExA 関数 (fileapi.h)

[アーティクル]
11/20/2024

指定したファイルまたはディレクトリの属性を取得します。

この操作をトランザクション操作として実行するには、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 列挙体の次の値を指定できます。

価値	意味
GetFileExInfoStandard をする	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 透過的フェールオーバー (TFO)	はい
SMB 3.0 とスケールアウトファイル共有 (SO)	はい
クラスター共有ボリュームファイルシステム (CsvFS)	はい
回復性のあるファイルシステム (ReFS)	はい

シンボリックリンクの動作: パスがシンボリックリンクを指している場合、関数はシンボリックリンクの属性を返します。

トランザクション操作の

トランザクションでファイルが変更のために開かれている場合、トランザクションがコミットされるまで、他のスレッドはファイルを開いて変更できません。そのため、トランザクションスレッドが最初にファイルを開くと、トランザクションがコミットされる前にファイルを変更しようとする後続のスレッドは共有違反を受け取ります。トランザクション以外のスレッドがトランザクションスレッドの前にファイルを変更しても、トランザクションが開こうとしたときにファイルが開いている場合、トランザクションはエラー ERROR_TRANSACTIONAL_CONFLICTを受け取ります。

手記

fileapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetFileAttributesEx を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows XP [デスクトップアプリ \|UWP アプリ]
サポートされる最小サーバー	Windows Server 2003 [デスクトップアプリ \|UWP アプリ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	fileapi.h (Windows.h を含む)
ライブラリ	Kernel32.lib
DLL	Kernel32.dll

次の方法で共有

GetFileAttributesExA 関数 (fileapi.h)

構文

パラメーター

戻り値

備考

トランザクション操作の

必要条件

関連項目

フィードバック

その他のリソース