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

GetFileInformationByHandleEx

関数
ハンドルから指定クラスのファイル情報を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL GetFileInformationByHandleEx(
    HANDLE hFile,
    FILE_INFO_BY_HANDLE_CLASS FileInformationClass,
    void* lpFileInformation,
    DWORD dwBufferSize
);

パラメーター

名前方向説明
hFileHANDLEin

取得対象の情報を含むファイルへのハンドル。

このハンドルはパイプハンドルであってはなりません。

FileInformationClassFILE_INFO_BY_HANDLE_CLASSin

取得する情報の種類を指定する FILE_INFO_BY_HANDLE_CLASS 列挙体の値。

有効な値の一覧については、「解説」セクションを参照してください。

lpFileInformationvoid*out要求されたファイル情報を受け取るバッファーへのポインター。返される構造体は、FileInformationClass で指定されたクラスに対応します。有効な構造体の種類の一覧については、「解説」セクションを参照してください。
dwBufferSizeDWORDinlpFileInformation バッファーのサイズ(バイト単位)。

戻り値の型: BOOL

公式ドキュメント

指定されたファイルのファイル情報を取得します。(GetFileInformationByHandleEx)

戻り値

関数が成功した場合、戻り値は 0 以外となり、ファイル情報データは lpFileInformation パラメーターが指すバッファーに格納されます。

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

解説(Remarks)

FileInformationClassFileStreamInfo で、呼び出しが成功したものの、ストリームが 1 つも返されなかった場合、GetLastError が返すエラーは ERROR_HANDLE_EOF です。

特定のファイル情報クラスは、オペレーティングシステムのリリースによって動作がわずかに異なります。これらのクラスは基盤となるドライバーによってサポートされており、返される情報はオペレーティングシステムのリリース間で変更される可能性があります。

次の表は、この関数で使用できる有効なファイル情報クラスの種類と、それに対応するデータ構造体の種類を示しています。

FileInformationClass の値 lpFileInformation の型
FileBasicInfo (0) FILE_BASIC_INFO
FileStandardInfo (1) FILE_STANDARD_INFO
FileNameInfo (2) FILE_NAME_INFO
FileStreamInfo (7) FILE_STREAM_INFO
FileCompressionInfo (8) FILE_COMPRESSION_INFO
FileAttributeTagInfo (9) FILE_ATTRIBUTE_TAG_INFO
FileIdBothDirectoryInfo (0xa) FILE_ID_BOTH_DIR_INFO
FileIdBothDirectoryRestartInfo (0xb) FILE_ID_BOTH_DIR_INFO
FileRemoteProtocolInfo (0xd) FILE_REMOTE_PROTOCOL_INFO
FileFullDirectoryInfo (0xe) FILE_FULL_DIR_INFO
FileFullDirectoryRestartInfo (0xf) FILE_FULL_DIR_INFO
FileStorageInfo (0x10) FILE_STORAGE_INFO
FileAlignmentInfo (0x11) FILE_ALIGNMENT_INFO
FileIdInfo (0x12) FILE_ID_INFO
FileIdExtdDirectoryInfo (0x13) FILE_ID_EXTD_DIR_INFO
FileIdExtdDirectoryRestartInfo (0x14) FILE_ID_EXTD_DIR_INFO

トランザクション操作

呼び出し時点でスレッドにトランザクションがバインドされている場合、この関数は分離されたファイルビューの圧縮ファイルサイズを返します。詳細については、About Transactional NTFS を参照してください。

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

テクノロジー サポート状況
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
SMB 3.0 with Scale-out File Shares (SO) はい
Cluster Shared Volume File System (CsvFS) はい
Resilient File System (ReFS) はい
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL GetFileInformationByHandleEx(
    HANDLE hFile,
    FILE_INFO_BY_HANDLE_CLASS FileInformationClass,
    void* lpFileInformation,
    DWORD dwBufferSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetFileInformationByHandleEx(
    IntPtr hFile,   // HANDLE
    int FileInformationClass,   // FILE_INFO_BY_HANDLE_CLASS
    IntPtr lpFileInformation,   // void* out
    uint dwBufferSize   // DWORD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFileInformationByHandleEx(
    hFile As IntPtr,   ' HANDLE
    FileInformationClass As Integer,   ' FILE_INFO_BY_HANDLE_CLASS
    lpFileInformation As IntPtr,   ' void* out
    dwBufferSize As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hFile : HANDLE
' FileInformationClass : FILE_INFO_BY_HANDLE_CLASS
' lpFileInformation : void* out
' dwBufferSize : DWORD
Declare PtrSafe Function GetFileInformationByHandleEx Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal FileInformationClass As Long, _
    ByVal lpFileInformation As LongPtr, _
    ByVal dwBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetFileInformationByHandleEx = ctypes.windll.kernel32.GetFileInformationByHandleEx
GetFileInformationByHandleEx.restype = wintypes.BOOL
GetFileInformationByHandleEx.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_int,  # FileInformationClass : FILE_INFO_BY_HANDLE_CLASS
    ctypes.POINTER(None),  # lpFileInformation : void* out
    wintypes.DWORD,  # dwBufferSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetFileInformationByHandleEx = kernel32.NewProc("GetFileInformationByHandleEx")
)

// hFile (HANDLE), FileInformationClass (FILE_INFO_BY_HANDLE_CLASS), lpFileInformation (void* out), dwBufferSize (DWORD)
r1, _, err := procGetFileInformationByHandleEx.Call(
	uintptr(hFile),
	uintptr(FileInformationClass),
	uintptr(lpFileInformation),
	uintptr(dwBufferSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetFileInformationByHandleEx(
  hFile: THandle;   // HANDLE
  FileInformationClass: Integer;   // FILE_INFO_BY_HANDLE_CLASS
  lpFileInformation: Pointer;   // void* out
  dwBufferSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetFileInformationByHandleEx';
result := DllCall("KERNEL32\GetFileInformationByHandleEx"
    , "Ptr", hFile   ; HANDLE
    , "Int", FileInformationClass   ; FILE_INFO_BY_HANDLE_CLASS
    , "Ptr", lpFileInformation   ; void* out
    , "UInt", dwBufferSize   ; DWORD
    , "Int")   ; return: BOOL
●GetFileInformationByHandleEx(hFile, FileInformationClass, lpFileInformation, dwBufferSize) = DLL("KERNEL32.dll", "bool GetFileInformationByHandleEx(void*, int, void*, dword)")
# 呼び出し: GetFileInformationByHandleEx(hFile, FileInformationClass, lpFileInformation, dwBufferSize)
# hFile : HANDLE -> "void*"
# FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> "int"
# lpFileInformation : void* out -> "void*"
# dwBufferSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetFileInformationByHandleEx(
    hFile: ?*anyopaque, // HANDLE
    FileInformationClass: i32, // FILE_INFO_BY_HANDLE_CLASS
    lpFileInformation: ?*anyopaque, // void* out
    dwBufferSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc GetFileInformationByHandleEx(
    hFile: pointer,  # HANDLE
    FileInformationClass: int32,  # FILE_INFO_BY_HANDLE_CLASS
    lpFileInformation: pointer,  # void* out
    dwBufferSize: uint32  # DWORD
): int32 {.importc: "GetFileInformationByHandleEx", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetFileInformationByHandleEx(
    void* hFile,   // HANDLE
    int FileInformationClass,   // FILE_INFO_BY_HANDLE_CLASS
    void* lpFileInformation,   // void* out
    uint dwBufferSize   // DWORD
);
ccall((:GetFileInformationByHandleEx, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}, UInt32),
      hFile, FileInformationClass, lpFileInformation, dwBufferSize)
# hFile : HANDLE -> Ptr{Cvoid}
# FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> Int32
# lpFileInformation : void* out -> Ptr{Cvoid}
# dwBufferSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetFileInformationByHandleEx(
    void* hFile,
    int32_t FileInformationClass,
    void* lpFileInformation,
    uint32_t dwBufferSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetFileInformationByHandleEx(hFile, FileInformationClass, lpFileInformation, dwBufferSize)
-- hFile : HANDLE
-- FileInformationClass : FILE_INFO_BY_HANDLE_CLASS
-- lpFileInformation : void* out
-- dwBufferSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetFileInformationByHandleEx = lib.func('__stdcall', 'GetFileInformationByHandleEx', 'int32_t', ['void *', 'int32_t', 'void *', 'uint32_t']);
// GetFileInformationByHandleEx(hFile, FileInformationClass, lpFileInformation, dwBufferSize)
// hFile : HANDLE -> 'void *'
// FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> 'int32_t'
// lpFileInformation : void* out -> 'void *'
// dwBufferSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetFileInformationByHandleEx: { parameters: ["pointer", "i32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.GetFileInformationByHandleEx(hFile, FileInformationClass, lpFileInformation, dwBufferSize)
// hFile : HANDLE -> "pointer"
// FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> "i32"
// lpFileInformation : void* out -> "pointer"
// dwBufferSize : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetFileInformationByHandleEx(
    void* hFile,
    int32_t FileInformationClass,
    void* lpFileInformation,
    uint32_t dwBufferSize);
C, "KERNEL32.dll");
// $ffi->GetFileInformationByHandleEx(hFile, FileInformationClass, lpFileInformation, dwBufferSize);
// hFile : HANDLE
// FileInformationClass : FILE_INFO_BY_HANDLE_CLASS
// lpFileInformation : void* out
// dwBufferSize : DWORD
// 構造体/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);
    boolean GetFileInformationByHandleEx(
        Pointer hFile,   // HANDLE
        int FileInformationClass,   // FILE_INFO_BY_HANDLE_CLASS
        Pointer lpFileInformation,   // void* out
        int dwBufferSize   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetFileInformationByHandleEx = GetFileInformationByHandleEx(
    hFile : Void*,   # HANDLE
    FileInformationClass : Int32,   # FILE_INFO_BY_HANDLE_CLASS
    lpFileInformation : Void*,   # void* out
    dwBufferSize : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetFileInformationByHandleExNative = Int32 Function(Pointer<Void>, Int32, Pointer<Void>, Uint32);
typedef GetFileInformationByHandleExDart = int Function(Pointer<Void>, int, Pointer<Void>, int);
final GetFileInformationByHandleEx = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetFileInformationByHandleExNative, GetFileInformationByHandleExDart>('GetFileInformationByHandleEx');
// hFile : HANDLE -> Pointer<Void>
// FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> Int32
// lpFileInformation : void* out -> Pointer<Void>
// dwBufferSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetFileInformationByHandleEx(
  hFile: THandle;   // HANDLE
  FileInformationClass: Integer;   // FILE_INFO_BY_HANDLE_CLASS
  lpFileInformation: Pointer;   // void* out
  dwBufferSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetFileInformationByHandleEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetFileInformationByHandleEx"
  c_GetFileInformationByHandleEx :: Ptr () -> Int32 -> Ptr () -> Word32 -> IO CInt
-- hFile : HANDLE -> Ptr ()
-- FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> Int32
-- lpFileInformation : void* out -> Ptr ()
-- dwBufferSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getfileinformationbyhandleex =
  foreign "GetFileInformationByHandleEx"
    ((ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> int32_t *)
(* lpFileInformation : void* out -> (ptr void) *)
(* dwBufferSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetFileInformationByHandleEx" get-file-information-by-handle-ex :convention :stdcall) :int32
  (h-file :pointer)   ; HANDLE
  (file-information-class :int32)   ; FILE_INFO_BY_HANDLE_CLASS
  (lp-file-information :pointer)   ; void* out
  (dw-buffer-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetFileInformationByHandleEx = Win32::API::More->new('KERNEL32',
    'BOOL GetFileInformationByHandleEx(HANDLE hFile, int FileInformationClass, LPVOID lpFileInformation, DWORD dwBufferSize)');
# my $ret = $GetFileInformationByHandleEx->Call($hFile, $FileInformationClass, $lpFileInformation, $dwBufferSize);
# hFile : HANDLE -> HANDLE
# FileInformationClass : FILE_INFO_BY_HANDLE_CLASS -> int
# lpFileInformation : void* out -> LPVOID
# dwBufferSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型