Win32 API 日本語リファレンス
ホームSystem.Memory › HeapSize

HeapSize

関数
ヒープ上のメモリブロックのサイズを取得する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

UINT_PTR HeapSize(
    HANDLE hHeap,
    HEAP_FLAGS dwFlags,
    const void* lpMem
);

パラメーター

名前方向説明
hHeapHANDLEinメモリ ブロックが存在するヒープへのハンドルです。このハンドルは HeapCreate 関数または GetProcessHeap 関数によって返されます。
dwFlagsHEAP_FLAGSin

ヒープ サイズのオプションです。次の値を指定すると、HeapCreate 関数でヒープを作成したときに flOptions パラメーターで指定した対応する値が上書きされます。

Value Meaning
HEAP_NO_SERIALIZE
0x00000001
シリアル化されたアクセスは使用されません。詳細については、「解説」を参照してください。

この関数へのすべての呼び出しでシリアル化されたアクセスを確実に無効にするには、HeapCreate の呼び出しで HEAP_NO_SERIALIZE を指定します。この場合、この関数の呼び出しで HEAP_NO_SERIALIZE を追加で指定する必要はありません。

この値は、プロセス ヒープにアクセスするときには指定しないでください。システムは、CTRL+C ハンドラーなど、プロセス ヒープに同時にアクセスする追加のスレッドをアプリケーションのプロセス内に作成する場合があります。

lpMemvoid*in関数がサイズを取得するメモリ ブロックへのポインターです。これは HeapAlloc 関数または HeapReAlloc 関数によって返されたポインターです。メモリ ブロックは、hHeap パラメーターで指定されたヒープから割り当てられたものである必要があります。

戻り値の型: UINT_PTR

公式ドキュメント

HeapAlloc 関数または HeapReAlloc 関数によってヒープから割り当てられたメモリ ブロックのサイズを取得します。

戻り値

関数が成功した場合、戻り値は割り当てられたメモリ ブロックの要求されたサイズ (バイト単位) です。

関数が失敗した場合、戻り値は (SIZE_T)-1 です。この関数は SetLastError を呼び出しません。アプリケーションは拡張エラー情報を取得するために GetLastError を呼び出すことはできません。

lpMem パラメーターが、hHeap パラメーターで指定されたヒープに存在しないヒープ割り当てを参照している場合、HeapSize 関数の動作は未定義です。

解説(Remarks)

シリアル化により、2 つ以上のスレッドが同じヒープから同時にブロックを割り当てまたは解放しようとした場合に、相互排他が保証されます。シリアル化にはわずかなパフォーマンス コストがかかりますが、複数のスレッドが同じヒープからメモリを割り当ておよび解放する場合には、常に使用する必要があります。HEAP_NO_SERIALIZE 値を設定すると、ヒープでの相互排他が無効になります。シリアル化を行わない場合、同じヒープ ハンドルを使用する 2 つ以上のスレッドが同時にメモリを割り当てまたは解放しようとし、ヒープの破損を引き起こす可能性があります。したがって、HEAP_NO_SERIALIZE 値は次の状況でのみ安全に使用できます。

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

各言語での呼び出し定義

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

UINT_PTR HeapSize(
    HANDLE hHeap,
    HEAP_FLAGS dwFlags,
    const void* lpMem
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern UIntPtr HeapSize(
    IntPtr hHeap,   // HANDLE
    uint dwFlags,   // HEAP_FLAGS
    IntPtr lpMem   // void*
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function HeapSize(
    hHeap As IntPtr,   ' HANDLE
    dwFlags As UInteger,   ' HEAP_FLAGS
    lpMem As IntPtr   ' void*
) As UIntPtr
End Function
' hHeap : HANDLE
' dwFlags : HEAP_FLAGS
' lpMem : void*
Declare PtrSafe Function HeapSize Lib "kernel32" ( _
    ByVal hHeap As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lpMem As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HeapSize = ctypes.windll.kernel32.HeapSize
HeapSize.restype = ctypes.c_size_t
HeapSize.argtypes = [
    wintypes.HANDLE,  # hHeap : HANDLE
    wintypes.DWORD,  # dwFlags : HEAP_FLAGS
    ctypes.POINTER(None),  # lpMem : void*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
HeapSize = Fiddle::Function.new(
  lib['HeapSize'],
  [
    Fiddle::TYPE_VOIDP,  # hHeap : HANDLE
    -Fiddle::TYPE_INT,  # dwFlags : HEAP_FLAGS
    Fiddle::TYPE_VOIDP,  # lpMem : void*
  ],
  Fiddle::TYPE_UINTPTR_T)
#[link(name = "kernel32")]
extern "system" {
    fn HeapSize(
        hHeap: *mut core::ffi::c_void,  // HANDLE
        dwFlags: u32,  // HEAP_FLAGS
        lpMem: *const ()  // void*
    ) -> usize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern UIntPtr HeapSize(IntPtr hHeap, uint dwFlags, IntPtr lpMem);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_HeapSize' -Namespace Win32 -PassThru
# $api::HeapSize(hHeap, dwFlags, lpMem)
#uselib "KERNEL32.dll"
#func global HeapSize "HeapSize" sptr, sptr, sptr
; HeapSize hHeap, dwFlags, lpMem   ; 戻り値は stat
; hHeap : HANDLE -> "sptr"
; dwFlags : HEAP_FLAGS -> "sptr"
; lpMem : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global HeapSize "HeapSize" sptr, int, sptr
; res = HeapSize(hHeap, dwFlags, lpMem)
; hHeap : HANDLE -> "sptr"
; dwFlags : HEAP_FLAGS -> "int"
; lpMem : void* -> "sptr"
; UINT_PTR HeapSize(HANDLE hHeap, HEAP_FLAGS dwFlags, void* lpMem)
#uselib "KERNEL32.dll"
#cfunc global HeapSize "HeapSize" intptr, int, intptr
; res = HeapSize(hHeap, dwFlags, lpMem)
; hHeap : HANDLE -> "intptr"
; dwFlags : HEAP_FLAGS -> "int"
; lpMem : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procHeapSize = kernel32.NewProc("HeapSize")
)

// hHeap (HANDLE), dwFlags (HEAP_FLAGS), lpMem (void*)
r1, _, err := procHeapSize.Call(
	uintptr(hHeap),
	uintptr(dwFlags),
	uintptr(lpMem),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // UINT_PTR
function HeapSize(
  hHeap: THandle;   // HANDLE
  dwFlags: DWORD;   // HEAP_FLAGS
  lpMem: Pointer   // void*
): NativeUInt; stdcall;
  external 'KERNEL32.dll' name 'HeapSize';
result := DllCall("KERNEL32\HeapSize"
    , "Ptr", hHeap   ; HANDLE
    , "UInt", dwFlags   ; HEAP_FLAGS
    , "Ptr", lpMem   ; void*
    , "UPtr")   ; return: UINT_PTR
●HeapSize(hHeap, dwFlags, lpMem) = DLL("KERNEL32.dll", "int HeapSize(void*, dword, void*)")
# 呼び出し: HeapSize(hHeap, dwFlags, lpMem)
# hHeap : HANDLE -> "void*"
# dwFlags : HEAP_FLAGS -> "dword"
# lpMem : void* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef HeapSizeNative = UintPtr Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef HeapSizeDart = int Function(Pointer<Void>, int, Pointer<Void>);
final HeapSize = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<HeapSizeNative, HeapSizeDart>('HeapSize');
// hHeap : HANDLE -> Pointer<Void>
// dwFlags : HEAP_FLAGS -> Uint32
// lpMem : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HeapSize(
  hHeap: THandle;   // HANDLE
  dwFlags: DWORD;   // HEAP_FLAGS
  lpMem: Pointer   // void*
): NativeUInt; stdcall;
  external 'KERNEL32.dll' name 'HeapSize';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HeapSize"
  c_HeapSize :: Ptr () -> Word32 -> Ptr () -> IO CUIntPtr
-- hHeap : HANDLE -> Ptr ()
-- dwFlags : HEAP_FLAGS -> Word32
-- lpMem : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let heapsize =
  foreign "HeapSize"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning size_t)
(* hHeap : HANDLE -> (ptr void) *)
(* dwFlags : HEAP_FLAGS -> uint32_t *)
(* lpMem : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("HeapSize" heap-size :convention :stdcall) :uint64
  (h-heap :pointer)   ; HANDLE
  (dw-flags :uint32)   ; HEAP_FLAGS
  (lp-mem :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HeapSize = Win32::API::More->new('KERNEL32',
    'WPARAM HeapSize(HANDLE hHeap, DWORD dwFlags, LPVOID lpMem)');
# my $ret = $HeapSize->Call($hHeap, $dwFlags, $lpMem);
# hHeap : HANDLE -> HANDLE
# dwFlags : HEAP_FLAGS -> DWORD
# lpMem : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型