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

GetFileSizeEx

関数
ファイルのサイズを64ビット値で取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL GetFileSizeEx(
    HANDLE hFile,
    LONGLONG* lpFileSize
);

パラメーター

名前方向説明
hFileHANDLEinファイルへのハンドル。このハンドルは FILE_READ_ATTRIBUTES アクセス権またはそれと同等の権限で作成されている必要があります。あるいは、呼び出し元がファイルを格納しているディレクトリに対して十分な権限を持っている必要があります。 詳細については、 File Security and Access Rights を参照してください。
lpFileSizeLONGLONG*outファイルサイズ(バイト単位)を受け取る LARGE_INTEGER 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定したファイルのサイズを取得します。

戻り値

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

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

解説(Remarks)

トランザクション操作: ファイルハンドルにトランザクションがバインドされている場合、この関数は分離されたファイルビューに関する情報を返します。

Windows ストアアプリ: GetFileSizeEx はサポートされていません。 GetFileInformationByHandleEx を使用してください。

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

GetFileSizeEx = ctypes.windll.kernel32.GetFileSizeEx
GetFileSizeEx.restype = wintypes.BOOL
GetFileSizeEx.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.POINTER(ctypes.c_longlong),  # lpFileSize : LONGLONG* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetFileSizeEx = kernel32.NewProc("GetFileSizeEx")
)

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

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

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

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

let getfilesizeex =
  foreign "GetFileSizeEx"
    ((ptr void) @-> (ptr int64_t) @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* lpFileSize : LONGLONG* out -> (ptr int64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

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

関連項目

類似 API