GetFileAttributesA 関数 (fileapi.h)
指定したファイルまたはディレクトリのファイル システム属性を取得します。
属性の詳細情報を取得するには、 GetFileAttributesEx 関数を 使用します。
この操作をトランザクション操作として実行するには、 GetFileAttributesTransacted 関数を 使用します。
構文
DWORD GetFileAttributesA(
[in] LPCSTR lpFileName
);
パラメーター
[in] lpFileName
ファイルまたはディレクトリの名前。
既定では、名前はMAX_PATH文字に制限されています。 この制限を 32,767 文字のワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。 詳細については、「ファイル、パス、および名前空間の名前付け」を参照してください。
ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を前もって指定しなくても、MAX_PATHの制限を削除するようにオプトインできます。 詳細については、「 名前付けファイル、パス、および名前空間 」の「パスの最大長制限」セクションを参照してください。
戻り値
関数が成功した場合、戻り値には指定したファイルまたはディレクトリの属性が含まれます。 属性値とその説明の一覧については、「 ファイル属性定数」を参照してください。
関数が失敗した場合、戻り値は INVALID_FILE_ATTRIBUTES。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
マウントされたフォルダーであるディレクトリで GetFileAttributes が呼び出されると、マウントされたフォルダーがディレクトリに関連付けられているボリューム内のルート ディレクトリの属性ではなく、ディレクトリのファイル システム属性が返されます。 関連付けられたボリュームのファイル属性を取得するには、 GetVolumeNameForVolumeMountPoint を 呼び出して、関連付けられたボリュームの名前を取得します。 次に、 GetFileAttributes の呼び出しで結果の名前を使用します。 結果は、関連付けられたボリューム上のルート ディレクトリの属性です。
ネットワーク共有に対して GetFileAttributes を呼び出すと、関数は失敗し、GetLastError はERROR_BAD_NETPATHを返します。 その共有上のサブフォルダーへのパスを指定する必要があります。
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 ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetFileAttributes を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows XP [デスクトップ アプリ |UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリ |UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | fileapi.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |