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

GetCompressedFileSizeW

関数
圧縮ファイルの実際のディスク使用サイズを取得する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetCompressedFileSizeW(
    LPCWSTR lpFileName,
    DWORD* lpFileSizeHigh   // optional
);

パラメーター

名前型方向説明
lpFileNameLPCWSTRin

ファイルの名前。

パイプや通信デバイスなどのシーク不可能なデバイス上のファイル名は指定しないでください。そのようなファイルのサイズには意味がありません。

このパラメーターにはパスを含めることができます。

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

ヒント

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

lpFileSizeHighDWORD*outoptional

圧縮されたファイルサイズの上位 DWORD。この関数の戻り値は、圧縮されたファイルサイズの下位 DWORD です。

圧縮されたファイルサイズの上位 DWORD が不要な場合、このパラメーターは NULL にすることができます。サイズが 4 ギガバイト未満のファイルでは、上位 DWORD は必要ありません。

戻り値の型: DWORD

公式ドキュメント

指定したファイルの格納に実際に使用されているディスク領域のバイト数を取得します。(Unicode)

戻り値

関数が成功した場合、戻り値は指定したファイルの格納に実際に使用されているディスク領域のバイト数の下位 DWORD であり、lpFileSizeHigh が NULL でない場合、関数はその実際の値の上位 DWORD を、そのパラメーターが指す DWORD に格納します。これは、圧縮されたファイルの場合は圧縮後のファイルサイズ、非圧縮ファイルの場合は実際のファイルサイズです。

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

戻り値が INVALID_FILE_SIZE で、かつ lpFileSizeHigh が NULL でない場合、アプリケーションは GetLastError を呼び出して、関数が成功したか(値が NO_ERROR)失敗したか(値が NO_ERROR 以外)を判断する必要があります。

解説(Remarks)

アプリケーションは、 GetVolumeInformation を呼び出し、その関数の lpFileSystemFlags パラメーターが指す DWORD 値内の FS_VOL_IS_COMPRESSED フラグの状態を確認することで、ボリュームが圧縮されているかどうかを判断できます。

ファイルが圧縮またはスパースファイルをサポートするボリューム上にない場合、またはファイルが圧縮されておらずスパースファイルでもない場合、取得される値は実際のファイルサイズであり、 GetFileSize の呼び出しによって返される値と同じです。

シンボリックリンクの動作 — パスがシンボリックリンクを指している場合、関数はターゲットのファイルサイズを返します。

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

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

fileapi.h ヘッダーは GetCompressedFileSize を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetCompressedFileSizeW(
    LPCWSTR lpFileName,
    DWORD* lpFileSizeHigh   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetCompressedFileSizeW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName,   // LPCWSTR
    IntPtr lpFileSizeHigh   // DWORD* optional, out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCompressedFileSizeW(
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String,   ' LPCWSTR
    lpFileSizeHigh As IntPtr   ' DWORD* optional, out
) As UInteger
End Function
' lpFileName : LPCWSTR
' lpFileSizeHigh : DWORD* optional, out
Declare PtrSafe Function GetCompressedFileSizeW Lib "kernel32" ( _
    ByVal lpFileName As LongPtr, _
    ByVal lpFileSizeHigh As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetCompressedFileSizeW = ctypes.windll.kernel32.GetCompressedFileSizeW
GetCompressedFileSizeW.restype = wintypes.DWORD
GetCompressedFileSizeW.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    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')
GetCompressedFileSizeW = Fiddle::Function.new(
  lib['GetCompressedFileSizeW'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpFileSizeHigh : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn GetCompressedFileSizeW(
        lpFileName: *const u16,  // LPCWSTR
        lpFileSizeHigh: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetCompressedFileSizeW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, IntPtr lpFileSizeHigh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetCompressedFileSizeW' -Namespace Win32 -PassThru
# $api::GetCompressedFileSizeW(lpFileName, lpFileSizeHigh)
#uselib "KERNEL32.dll"
#func global GetCompressedFileSizeW "GetCompressedFileSizeW" wptr, wptr
; GetCompressedFileSizeW lpFileName, varptr(lpFileSizeHigh)   ; 戻り値は stat
; lpFileName : LPCWSTR -> "wptr"
; lpFileSizeHigh : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global GetCompressedFileSizeW "GetCompressedFileSizeW" wstr, var
; res = GetCompressedFileSizeW(lpFileName, lpFileSizeHigh)
; lpFileName : LPCWSTR -> "wstr"
; lpFileSizeHigh : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD GetCompressedFileSizeW(LPCWSTR lpFileName, DWORD* lpFileSizeHigh)
#uselib "KERNEL32.dll"
#cfunc global GetCompressedFileSizeW "GetCompressedFileSizeW" wstr, var
; res = GetCompressedFileSizeW(lpFileName, lpFileSizeHigh)
; lpFileName : LPCWSTR -> "wstr"
; lpFileSizeHigh : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetCompressedFileSizeW = kernel32.NewProc("GetCompressedFileSizeW")
)

// lpFileName (LPCWSTR), lpFileSizeHigh (DWORD* optional, out)
r1, _, err := procGetCompressedFileSizeW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
	uintptr(lpFileSizeHigh),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetCompressedFileSizeW(
  lpFileName: PWideChar;   // LPCWSTR
  lpFileSizeHigh: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetCompressedFileSizeW';
result := DllCall("KERNEL32\GetCompressedFileSizeW"
    , "WStr", lpFileName   ; LPCWSTR
    , "Ptr", lpFileSizeHigh   ; DWORD* optional, out
    , "UInt")   ; return: DWORD
●GetCompressedFileSizeW(lpFileName, lpFileSizeHigh) = DLL("KERNEL32.dll", "dword GetCompressedFileSizeW(char*, void*)")
# 呼び出し: GetCompressedFileSizeW(lpFileName, lpFileSizeHigh)
# lpFileName : LPCWSTR -> "char*"
# lpFileSizeHigh : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn GetCompressedFileSizeW(
    lpFileName: [*c]const u16, // LPCWSTR
    lpFileSizeHigh: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetCompressedFileSizeW(
    lpFileName: WideCString,  # LPCWSTR
    lpFileSizeHigh: ptr uint32  # DWORD* optional, out
): uint32 {.importc: "GetCompressedFileSizeW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
uint GetCompressedFileSizeW(
    const(wchar)* lpFileName,   // LPCWSTR
    uint* lpFileSizeHigh   // DWORD* optional, out
);
ccall((:GetCompressedFileSizeW, "KERNEL32.dll"), stdcall, UInt32,
      (Cwstring, Ptr{UInt32}),
      lpFileName, lpFileSizeHigh)
# lpFileName : LPCWSTR -> Cwstring
# lpFileSizeHigh : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetCompressedFileSizeW(
    const uint16_t* lpFileName,
    uint32_t* lpFileSizeHigh);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetCompressedFileSizeW(lpFileName, lpFileSizeHigh)
-- lpFileName : LPCWSTR
-- lpFileSizeHigh : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetCompressedFileSizeW = lib.func('__stdcall', 'GetCompressedFileSizeW', 'uint32_t', ['str16', 'uint32_t *']);
// GetCompressedFileSizeW(lpFileName, lpFileSizeHigh)
// lpFileName : LPCWSTR -> 'str16'
// lpFileSizeHigh : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetCompressedFileSizeW: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.GetCompressedFileSizeW(lpFileName, lpFileSizeHigh)
// lpFileName : LPCWSTR -> "buffer"
// lpFileSizeHigh : DWORD* optional, out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetCompressedFileSizeW(
    const uint16_t* lpFileName,
    uint32_t* lpFileSizeHigh);
C, "KERNEL32.dll");
// $ffi->GetCompressedFileSizeW(lpFileName, lpFileSizeHigh);
// lpFileName : LPCWSTR
// lpFileSizeHigh : DWORD* optional, 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.UNICODE_OPTIONS);
    int GetCompressedFileSizeW(
        WString lpFileName,   // LPCWSTR
        IntByReference lpFileSizeHigh   // DWORD* optional, out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetCompressedFileSizeW = GetCompressedFileSizeW(
    lpFileName : UInt16*,   # LPCWSTR
    lpFileSizeHigh : UInt32*   # DWORD* optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetCompressedFileSizeWNative = Uint32 Function(Pointer<Utf16>, Pointer<Uint32>);
typedef GetCompressedFileSizeWDart = int Function(Pointer<Utf16>, Pointer<Uint32>);
final GetCompressedFileSizeW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetCompressedFileSizeWNative, GetCompressedFileSizeWDart>('GetCompressedFileSizeW');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// lpFileSizeHigh : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetCompressedFileSizeW(
  lpFileName: PWideChar;   // LPCWSTR
  lpFileSizeHigh: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetCompressedFileSizeW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetCompressedFileSizeW"
  c_GetCompressedFileSizeW :: CWString -> Ptr Word32 -> IO Word32
-- lpFileName : LPCWSTR -> CWString
-- lpFileSizeHigh : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getcompressedfilesizew =
  foreign "GetCompressedFileSizeW"
    ((ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* lpFileSizeHigh : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetCompressedFileSizeW" get-compressed-file-size-w :convention :stdcall) :uint32
  (lp-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-file-size-high :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetCompressedFileSizeW = Win32::API::More->new('KERNEL32',
    'DWORD GetCompressedFileSizeW(LPCWSTR lpFileName, LPVOID lpFileSizeHigh)');
# my $ret = $GetCompressedFileSizeW->Call($lpFileName, $lpFileSizeHigh);
# lpFileName : LPCWSTR -> LPCWSTR
# lpFileSizeHigh : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目