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

GetCompressedFileSizeA

関数
圧縮ファイルの実際のディスク使用サイズを取得する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetCompressedFileSizeA(
    LPCSTR lpFileName,
    DWORD* lpFileSizeHigh   // optional
);

パラメーター

名前方向説明
lpFileNameLPCSTRin

ファイルの名前。

パイプや通信デバイスなど、シークできないデバイス上のファイル名は指定しないでください。これらのファイルサイズには意味がありません。

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

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

ヒント

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

lpFileSizeHighDWORD*outoptional

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

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

戻り値が INVALID_FILE_SIZElpFileSizeHighNULL 以外の場合、アプリケーションは 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 Transparent Failover (TFO) はい
SMB 3.0 with Scale-out File Shares (SO) はい
Cluster Shared Volume File System (CsvFS) はい
Resilient File System (ReFS) はい
メモ

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

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

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetCompressedFileSizeA(
    LPCSTR lpFileName,
    DWORD* lpFileSizeHigh   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetCompressedFileSizeA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName,   // LPCSTR
    IntPtr lpFileSizeHigh   // DWORD* optional, out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCompressedFileSizeA(
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String,   ' LPCSTR
    lpFileSizeHigh As IntPtr   ' DWORD* optional, out
) As UInteger
End Function
' lpFileName : LPCSTR
' lpFileSizeHigh : DWORD* optional, out
Declare PtrSafe Function GetCompressedFileSizeA Lib "kernel32" ( _
    ByVal lpFileName As String, _
    ByVal lpFileSizeHigh As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetCompressedFileSizeA = kernel32.NewProc("GetCompressedFileSizeA")
)

// lpFileName (LPCSTR), lpFileSizeHigh (DWORD* optional, out)
r1, _, err := procGetCompressedFileSizeA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
	uintptr(lpFileSizeHigh),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetCompressedFileSizeA(
  lpFileName: PAnsiChar;   // LPCSTR
  lpFileSizeHigh: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetCompressedFileSizeA';
result := DllCall("KERNEL32\GetCompressedFileSizeA"
    , "AStr", lpFileName   ; LPCSTR
    , "Ptr", lpFileSizeHigh   ; DWORD* optional, out
    , "UInt")   ; return: DWORD
●GetCompressedFileSizeA(lpFileName, lpFileSizeHigh) = DLL("KERNEL32.dll", "dword GetCompressedFileSizeA(char*, void*)")
# 呼び出し: GetCompressedFileSizeA(lpFileName, lpFileSizeHigh)
# lpFileName : LPCSTR -> "char*"
# lpFileSizeHigh : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetCompressedFileSizeA(
    lpFileName: [*c]const u8, // LPCSTR
    lpFileSizeHigh: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;
proc GetCompressedFileSizeA(
    lpFileName: cstring,  # LPCSTR
    lpFileSizeHigh: ptr uint32  # DWORD* optional, out
): uint32 {.importc: "GetCompressedFileSizeA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint GetCompressedFileSizeA(
    const(char)* lpFileName,   // LPCSTR
    uint* lpFileSizeHigh   // DWORD* optional, out
);
ccall((:GetCompressedFileSizeA, "KERNEL32.dll"), stdcall, UInt32,
      (Cstring, Ptr{UInt32}),
      lpFileName, lpFileSizeHigh)
# lpFileName : LPCSTR -> Cstring
# lpFileSizeHigh : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetCompressedFileSizeA(
    const char* lpFileName,
    uint32_t* lpFileSizeHigh);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetCompressedFileSizeA(lpFileName, lpFileSizeHigh)
-- lpFileName : LPCSTR
-- lpFileSizeHigh : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetCompressedFileSizeA = lib.func('__stdcall', 'GetCompressedFileSizeA', 'uint32_t', ['str', 'uint32_t *']);
// GetCompressedFileSizeA(lpFileName, lpFileSizeHigh)
// lpFileName : LPCSTR -> 'str'
// lpFileSizeHigh : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetCompressedFileSizeA: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.GetCompressedFileSizeA(lpFileName, lpFileSizeHigh)
// lpFileName : LPCSTR -> "buffer"
// lpFileSizeHigh : DWORD* optional, out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetCompressedFileSizeA(
    const char* lpFileName,
    uint32_t* lpFileSizeHigh);
C, "KERNEL32.dll");
// $ffi->GetCompressedFileSizeA(lpFileName, lpFileSizeHigh);
// lpFileName : LPCSTR
// 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.ASCII_OPTIONS);
    int GetCompressedFileSizeA(
        String lpFileName,   // LPCSTR
        IntByReference lpFileSizeHigh   // DWORD* optional, out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetCompressedFileSizeA = GetCompressedFileSizeA(
    lpFileName : UInt8*,   # LPCSTR
    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 GetCompressedFileSizeANative = Uint32 Function(Pointer<Utf8>, Pointer<Uint32>);
typedef GetCompressedFileSizeADart = int Function(Pointer<Utf8>, Pointer<Uint32>);
final GetCompressedFileSizeA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetCompressedFileSizeANative, GetCompressedFileSizeADart>('GetCompressedFileSizeA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// lpFileSizeHigh : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetCompressedFileSizeA(
  lpFileName: PAnsiChar;   // LPCSTR
  lpFileSizeHigh: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetCompressedFileSizeA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getcompressedfilesizea =
  foreign "GetCompressedFileSizeA"
    (string @-> (ptr uint32_t) @-> returning uint32_t)
(* lpFileName : LPCSTR -> string *)
(* 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 ("GetCompressedFileSizeA" get-compressed-file-size-a :convention :stdcall) :uint32
  (lp-file-name :string)   ; LPCSTR
  (lp-file-size-high :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetCompressedFileSizeA = Win32::API::More->new('KERNEL32',
    'DWORD GetCompressedFileSizeA(LPCSTR lpFileName, LPVOID lpFileSizeHigh)');
# my $ret = $GetCompressedFileSizeA->Call($lpFileName, $lpFileSizeHigh);
# lpFileName : LPCSTR -> LPCSTR
# lpFileSizeHigh : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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