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

GetFileInformationByHandle

関数
ハンドルからファイルの各種情報を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL GetFileInformationByHandle(
    HANDLE hFile,
    BY_HANDLE_FILE_INFORMATION* lpFileInformation
);

パラメーター

名前方向説明
hFileHANDLEin

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

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

lpFileInformationBY_HANDLE_FILE_INFORMATION*outファイル情報を受け取る BY_HANDLE_FILE_INFORMATION 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

オペレーティングシステムの基盤となるネットワーク機能や、接続先のサーバーの種類によっては、 GetFileInformationByHandle 関数は失敗するか、 対象ファイルについて部分的な情報または完全な情報を返すことがあります。

BY_HANDLE_FILE_INFORMATION 構造体で返される VolumeSerialNumber メンバーと FileIndex メンバーを比較することで、2 つのパスが同一のターゲットを指しているかどうかを 判断できます。たとえば、2 つのファイルパスを比較し、それらが 同一のディレクトリを指しているかどうかを判断できます。

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) はい

トランザクション処理

呼び出し時にスレッドにバインドされたトランザクションが存在する場合、この関数は 分離されたファイルビューの圧縮ファイルサイズを返します。詳細については、 About Transactional NTFS を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

GetFileInformationByHandle = ctypes.windll.kernel32.GetFileInformationByHandle
GetFileInformationByHandle.restype = wintypes.BOOL
GetFileInformationByHandle.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_void_p,  # lpFileInformation : BY_HANDLE_FILE_INFORMATION* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetFileInformationByHandle = Fiddle::Function.new(
  lib['GetFileInformationByHandle'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # lpFileInformation : BY_HANDLE_FILE_INFORMATION* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetFileInformationByHandle(
        hFile: *mut core::ffi::c_void,  // HANDLE
        lpFileInformation: *mut BY_HANDLE_FILE_INFORMATION  // BY_HANDLE_FILE_INFORMATION* out
    ) -> 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 GetFileInformationByHandle(IntPtr hFile, IntPtr lpFileInformation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetFileInformationByHandle' -Namespace Win32 -PassThru
# $api::GetFileInformationByHandle(hFile, lpFileInformation)
#uselib "KERNEL32.dll"
#func global GetFileInformationByHandle "GetFileInformationByHandle" sptr, sptr
; GetFileInformationByHandle hFile, varptr(lpFileInformation)   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; lpFileInformation : BY_HANDLE_FILE_INFORMATION* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetFileInformationByHandle "GetFileInformationByHandle" sptr, var
; res = GetFileInformationByHandle(hFile, lpFileInformation)
; hFile : HANDLE -> "sptr"
; lpFileInformation : BY_HANDLE_FILE_INFORMATION* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetFileInformationByHandle(HANDLE hFile, BY_HANDLE_FILE_INFORMATION* lpFileInformation)
#uselib "KERNEL32.dll"
#cfunc global GetFileInformationByHandle "GetFileInformationByHandle" intptr, var
; res = GetFileInformationByHandle(hFile, lpFileInformation)
; hFile : HANDLE -> "intptr"
; lpFileInformation : BY_HANDLE_FILE_INFORMATION* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetFileInformationByHandle = kernel32.NewProc("GetFileInformationByHandle")
)

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

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

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

foreign import stdcall safe "GetFileInformationByHandle"
  c_GetFileInformationByHandle :: Ptr () -> Ptr () -> IO CInt
-- hFile : HANDLE -> Ptr ()
-- lpFileInformation : BY_HANDLE_FILE_INFORMATION* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getfileinformationbyhandle =
  foreign "GetFileInformationByHandle"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* lpFileInformation : BY_HANDLE_FILE_INFORMATION* 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 ("GetFileInformationByHandle" get-file-information-by-handle :convention :stdcall) :int32
  (h-file :pointer)   ; HANDLE
  (lp-file-information :pointer))   ; BY_HANDLE_FILE_INFORMATION* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetFileInformationByHandle = Win32::API::More->new('KERNEL32',
    'BOOL GetFileInformationByHandle(HANDLE hFile, LPVOID lpFileInformation)');
# my $ret = $GetFileInformationByHandle->Call($hFile, $lpFileInformation);
# hFile : HANDLE -> HANDLE
# lpFileInformation : BY_HANDLE_FILE_INFORMATION* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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