Win32 API 日本語リファレンス
ホームStorage.FileSystem › GetFileAttributesExA

GetFileAttributesExA

関数
指定ファイルの属性や時刻などの拡張情報を取得する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetFileAttributesExA(
    LPCSTR lpFileName,
    GET_FILEEX_INFO_LEVELS fInfoLevelId,
    void* lpFileInformation
);

パラメーター

名前方向説明
lpFileNameLPCSTRin

ファイルまたはディレクトリの名前です。

既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH 制限を解除するオプトインが可能です。詳細については、ファイル、パス、名前空間の名前付けの「最大パス長の制限」セクションを参照してください。

fInfoLevelIdGET_FILEEX_INFO_LEVELSin

取得する属性情報のクラスです。

このパラメーターには、 GET_FILEEX_INFO_LEVELS 列挙体の次の値を指定できます。

意味
GetFileExInfoStandard
lpFileInformation パラメーターは WIN32_FILE_ATTRIBUTE_DATA 構造体です。
lpFileInformationvoid*out

属性情報を受け取るバッファーへのポインターです。

このバッファーに格納される属性情報の種類は、 fInfoLevelId の値によって決まります。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

GetFileAttributes 関数はファイル システム属性情報を取得します。GetFileAttributesEx は、ファイルまたはディレクトリの属性情報の別のセットを取得できます。現在、 GetFileAttributesEx は、ファイル システム属性情報のスーパーセットである標準属性のセットを取得します。

GetFileAttributesEx 関数を、マウントされたフォルダーであるディレクトリに対して呼び出すと、そのディレクトリの属性が返されます。マウントされたフォルダーがディレクトリに関連付けているボリューム内のルート ディレクトリの属性は返されません。関連付けられたボリュームの属性を取得するには、 GetVolumeNameForVolumeMountPoint を呼び出して 関連付けられたボリュームの名前を取得します。次に、得られた名前を使用して GetFileAttributesEx を呼び出します。その結果は、関連付けられたボリュームのルート ディレクトリの属性になります。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 透過的フェールオーバー (TFO) はい
SMB 3.0 スケールアウト ファイル共有 (SO) はい
クラスター共有ボリューム ファイル システム (CsvFS) はい
回復性ファイル システム (ReFS) はい

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

トランザクション操作

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

fileapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetFileAttributesEx を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイル エラーまたは実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetFileAttributesExA(
    LPCSTR lpFileName,
    GET_FILEEX_INFO_LEVELS fInfoLevelId,
    void* lpFileInformation
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetFileAttributesExA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName,   // LPCSTR
    int fInfoLevelId,   // GET_FILEEX_INFO_LEVELS
    IntPtr lpFileInformation   // void* out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFileAttributesExA(
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String,   ' LPCSTR
    fInfoLevelId As Integer,   ' GET_FILEEX_INFO_LEVELS
    lpFileInformation As IntPtr   ' void* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpFileName : LPCSTR
' fInfoLevelId : GET_FILEEX_INFO_LEVELS
' lpFileInformation : void* out
Declare PtrSafe Function GetFileAttributesExA Lib "kernel32" ( _
    ByVal lpFileName As String, _
    ByVal fInfoLevelId As Long, _
    ByVal lpFileInformation As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetFileAttributesExA = ctypes.windll.kernel32.GetFileAttributesExA
GetFileAttributesExA.restype = wintypes.BOOL
GetFileAttributesExA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    ctypes.c_int,  # fInfoLevelId : GET_FILEEX_INFO_LEVELS
    ctypes.POINTER(None),  # lpFileInformation : void* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetFileAttributesExA = Fiddle::Function.new(
  lib['GetFileAttributesExA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
    Fiddle::TYPE_INT,  # fInfoLevelId : GET_FILEEX_INFO_LEVELS
    Fiddle::TYPE_VOIDP,  # lpFileInformation : void* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetFileAttributesExA(
        lpFileName: *const u8,  // LPCSTR
        fInfoLevelId: i32,  // GET_FILEEX_INFO_LEVELS
        lpFileInformation: *mut ()  // void* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool GetFileAttributesExA([MarshalAs(UnmanagedType.LPStr)] string lpFileName, int fInfoLevelId, IntPtr lpFileInformation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetFileAttributesExA' -Namespace Win32 -PassThru
# $api::GetFileAttributesExA(lpFileName, fInfoLevelId, lpFileInformation)
#uselib "KERNEL32.dll"
#func global GetFileAttributesExA "GetFileAttributesExA" sptr, sptr, sptr
; GetFileAttributesExA lpFileName, fInfoLevelId, lpFileInformation   ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; fInfoLevelId : GET_FILEEX_INFO_LEVELS -> "sptr"
; lpFileInformation : void* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GetFileAttributesExA "GetFileAttributesExA" str, int, sptr
; res = GetFileAttributesExA(lpFileName, fInfoLevelId, lpFileInformation)
; lpFileName : LPCSTR -> "str"
; fInfoLevelId : GET_FILEEX_INFO_LEVELS -> "int"
; lpFileInformation : void* out -> "sptr"
; BOOL GetFileAttributesExA(LPCSTR lpFileName, GET_FILEEX_INFO_LEVELS fInfoLevelId, void* lpFileInformation)
#uselib "KERNEL32.dll"
#cfunc global GetFileAttributesExA "GetFileAttributesExA" str, int, intptr
; res = GetFileAttributesExA(lpFileName, fInfoLevelId, lpFileInformation)
; lpFileName : LPCSTR -> "str"
; fInfoLevelId : GET_FILEEX_INFO_LEVELS -> "int"
; lpFileInformation : void* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetFileAttributesExA = kernel32.NewProc("GetFileAttributesExA")
)

// lpFileName (LPCSTR), fInfoLevelId (GET_FILEEX_INFO_LEVELS), lpFileInformation (void* out)
r1, _, err := procGetFileAttributesExA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
	uintptr(fInfoLevelId),
	uintptr(lpFileInformation),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetFileAttributesExA(
  lpFileName: PAnsiChar;   // LPCSTR
  fInfoLevelId: Integer;   // GET_FILEEX_INFO_LEVELS
  lpFileInformation: Pointer   // void* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetFileAttributesExA';
result := DllCall("KERNEL32\GetFileAttributesExA"
    , "AStr", lpFileName   ; LPCSTR
    , "Int", fInfoLevelId   ; GET_FILEEX_INFO_LEVELS
    , "Ptr", lpFileInformation   ; void* out
    , "Int")   ; return: BOOL
●GetFileAttributesExA(lpFileName, fInfoLevelId, lpFileInformation) = DLL("KERNEL32.dll", "bool GetFileAttributesExA(char*, int, void*)")
# 呼び出し: GetFileAttributesExA(lpFileName, fInfoLevelId, lpFileInformation)
# lpFileName : LPCSTR -> "char*"
# fInfoLevelId : GET_FILEEX_INFO_LEVELS -> "int"
# lpFileInformation : void* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetFileAttributesExA(
    lpFileName: [*c]const u8, // LPCSTR
    fInfoLevelId: i32, // GET_FILEEX_INFO_LEVELS
    lpFileInformation: ?*anyopaque // void* out
) callconv(std.os.windows.WINAPI) i32;
proc GetFileAttributesExA(
    lpFileName: cstring,  # LPCSTR
    fInfoLevelId: int32,  # GET_FILEEX_INFO_LEVELS
    lpFileInformation: pointer  # void* out
): int32 {.importc: "GetFileAttributesExA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetFileAttributesExA(
    const(char)* lpFileName,   // LPCSTR
    int fInfoLevelId,   // GET_FILEEX_INFO_LEVELS
    void* lpFileInformation   // void* out
);
ccall((:GetFileAttributesExA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Int32, Ptr{Cvoid}),
      lpFileName, fInfoLevelId, lpFileInformation)
# lpFileName : LPCSTR -> Cstring
# fInfoLevelId : GET_FILEEX_INFO_LEVELS -> Int32
# lpFileInformation : void* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetFileAttributesExA(
    const char* lpFileName,
    int32_t fInfoLevelId,
    void* lpFileInformation);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetFileAttributesExA(lpFileName, fInfoLevelId, lpFileInformation)
-- lpFileName : LPCSTR
-- fInfoLevelId : GET_FILEEX_INFO_LEVELS
-- lpFileInformation : void* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetFileAttributesExA = lib.func('__stdcall', 'GetFileAttributesExA', 'int32_t', ['str', 'int32_t', 'void *']);
// GetFileAttributesExA(lpFileName, fInfoLevelId, lpFileInformation)
// lpFileName : LPCSTR -> 'str'
// fInfoLevelId : GET_FILEEX_INFO_LEVELS -> 'int32_t'
// lpFileInformation : void* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetFileAttributesExA: { parameters: ["buffer", "i32", "pointer"], result: "i32" },
});
// lib.symbols.GetFileAttributesExA(lpFileName, fInfoLevelId, lpFileInformation)
// lpFileName : LPCSTR -> "buffer"
// fInfoLevelId : GET_FILEEX_INFO_LEVELS -> "i32"
// lpFileInformation : void* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetFileAttributesExA(
    const char* lpFileName,
    int32_t fInfoLevelId,
    void* lpFileInformation);
C, "KERNEL32.dll");
// $ffi->GetFileAttributesExA(lpFileName, fInfoLevelId, lpFileInformation);
// lpFileName : LPCSTR
// fInfoLevelId : GET_FILEEX_INFO_LEVELS
// lpFileInformation : void* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
    boolean GetFileAttributesExA(
        String lpFileName,   // LPCSTR
        int fInfoLevelId,   // GET_FILEEX_INFO_LEVELS
        Pointer lpFileInformation   // void* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetFileAttributesExA = GetFileAttributesExA(
    lpFileName : UInt8*,   # LPCSTR
    fInfoLevelId : Int32,   # GET_FILEEX_INFO_LEVELS
    lpFileInformation : Void*   # void* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetFileAttributesExANative = Int32 Function(Pointer<Utf8>, Int32, Pointer<Void>);
typedef GetFileAttributesExADart = int Function(Pointer<Utf8>, int, Pointer<Void>);
final GetFileAttributesExA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetFileAttributesExANative, GetFileAttributesExADart>('GetFileAttributesExA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// fInfoLevelId : GET_FILEEX_INFO_LEVELS -> Int32
// lpFileInformation : void* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetFileAttributesExA(
  lpFileName: PAnsiChar;   // LPCSTR
  fInfoLevelId: Integer;   // GET_FILEEX_INFO_LEVELS
  lpFileInformation: Pointer   // void* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetFileAttributesExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetFileAttributesExA"
  c_GetFileAttributesExA :: CString -> Int32 -> Ptr () -> IO CInt
-- lpFileName : LPCSTR -> CString
-- fInfoLevelId : GET_FILEEX_INFO_LEVELS -> Int32
-- lpFileInformation : void* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getfileattributesexa =
  foreign "GetFileAttributesExA"
    (string @-> int32_t @-> (ptr void) @-> returning int32_t)
(* lpFileName : LPCSTR -> string *)
(* fInfoLevelId : GET_FILEEX_INFO_LEVELS -> int32_t *)
(* lpFileInformation : void* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetFileAttributesExA" get-file-attributes-ex-a :convention :stdcall) :int32
  (lp-file-name :string)   ; LPCSTR
  (f-info-level-id :int32)   ; GET_FILEEX_INFO_LEVELS
  (lp-file-information :pointer))   ; void* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetFileAttributesExA = Win32::API::More->new('KERNEL32',
    'BOOL GetFileAttributesExA(LPCSTR lpFileName, int fInfoLevelId, LPVOID lpFileInformation)');
# my $ret = $GetFileAttributesExA->Call($lpFileName, $fInfoLevelId, $lpFileInformation);
# lpFileName : LPCSTR -> LPCSTR
# fInfoLevelId : GET_FILEEX_INFO_LEVELS -> int
# lpFileInformation : void* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型