GetFileSize

関数

ファイルのサイズを取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD GetFileSize(
    HANDLE hFile,
    DWORD* lpFileSizeHigh   // optional
);

パラメーター

名前	型	方向	説明
hFile	HANDLE	in	ファイルへのハンドルです。
lpFileSizeHigh	DWORD*	outoptional	ファイルサイズの上位ダブルワードが返される変数へのポインターです。アプリケーションが上位ダブルワードを必要としない場合、このパラメーターには NULL を指定できます。

戻り値の型: DWORD

公式ドキュメント

指定したファイルのサイズをバイト単位で取得します。

戻り値

関数が成功した場合、戻り値はファイルサイズの下位ダブルワードです。また、lpFileSizeHigh が NULL 以外の場合、関数はファイルサイズの上位ダブルワードを、そのパラメーターが指す変数に格納します。

関数が失敗し、かつ lpFileSizeHigh が NULL の場合、戻り値は INVALID_FILE_SIZE です。拡張エラー情報を取得するには、GetLastError を呼び出します。lpFileSizeHigh が NULL の場合、大きなファイルに対して返される結果はあいまいになり、ファイルの実際のサイズを判別できません。代わりに GetFileSizeEx を使用することをお勧めします。

関数が失敗し、かつ lpFileSizeHigh が NULL 以外の場合、戻り値は INVALID_FILE_SIZE であり、GetLastError は NO_ERROR 以外の値を返します。

解説(Remarks)

パイプや通信デバイスのようなシーク不可能なデバイスのハンドルに対しては、GetFileSize 関数を使用できません。hFile のファイル種別を判別するには、GetFileType 関数を使用します。

GetFileSize 関数はファイルの非圧縮サイズを取得します。ファイルの圧縮サイズを取得するには、GetCompressedFileSize 関数を使用します。

戻り値が INVALID_FILE_SIZE (0xffffffff) の場合、関数が成功したか失敗したかを判別するために、アプリケーションは GetLastError を呼び出す必要があります。関数が失敗していないのに失敗したように見えることがあるのは、lpFileSizeHigh が NULL 以外であるか、ファイルサイズが 0xffffffff である可能性があるためです。この場合、成功時には GetLastError は NO_ERROR (0) を返します。この動作のため、代わりに GetFileSizeEx を使用することをお勧めします。

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

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

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

例

例については、Creating a View Within a File を参照してください。

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

各言語での呼び出し定義

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

DWORD GetFileSize(
    HANDLE hFile,
    DWORD* lpFileSizeHigh   // optional
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint GetFileSize(
    IntPtr hFile,   // HANDLE
    IntPtr lpFileSizeHigh   // DWORD* optional, out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFileSize(
    hFile As IntPtr,   ' HANDLE
    lpFileSizeHigh As IntPtr   ' DWORD* optional, out
) As UInteger
End Function

' hFile : HANDLE
' lpFileSizeHigh : DWORD* optional, out
Declare PtrSafe Function GetFileSize Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal lpFileSizeHigh As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetFileSize = ctypes.windll.kernel32.GetFileSize
GetFileSize.restype = wintypes.DWORD
GetFileSize.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # lpFileSizeHigh : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetFileSize = Fiddle::Function.new(
  lib['GetFileSize'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # lpFileSizeHigh : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetFileSize(
        hFile: *mut core::ffi::c_void,  // HANDLE
        lpFileSizeHigh: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern uint GetFileSize(IntPtr hFile, IntPtr lpFileSizeHigh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetFileSize' -Namespace Win32 -PassThru
# $api::GetFileSize(hFile, lpFileSizeHigh)

#uselib "KERNEL32.dll"
#func global GetFileSize "GetFileSize" sptr, sptr
; GetFileSize hFile, varptr(lpFileSizeHigh)   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; lpFileSizeHigh : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetFileSize "GetFileSize" sptr, var
; res = GetFileSize(hFile, lpFileSizeHigh)
; hFile : HANDLE -> "sptr"
; lpFileSizeHigh : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetFileSize "GetFileSize" sptr, sptr
; res = GetFileSize(hFile, varptr(lpFileSizeHigh))
; hFile : HANDLE -> "sptr"
; lpFileSizeHigh : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。