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

HeapSummary

関数
ヒープの使用状況の概要を取得する。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL HeapSummary(
    HANDLE hHeap,
    DWORD dwFlags,
    HEAP_SUMMARY* lpSummary
);

パラメーター

名前方向
hHeapHANDLEin
dwFlagsDWORDin
lpSummaryHEAP_SUMMARY*out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL HeapSummary(
    HANDLE hHeap,
    DWORD dwFlags,
    HEAP_SUMMARY* lpSummary
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool HeapSummary(
    IntPtr hHeap,   // HANDLE
    uint dwFlags,   // DWORD
    IntPtr lpSummary   // HEAP_SUMMARY* out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function HeapSummary(
    hHeap As IntPtr,   ' HANDLE
    dwFlags As UInteger,   ' DWORD
    lpSummary As IntPtr   ' HEAP_SUMMARY* out
) As Boolean
End Function
' hHeap : HANDLE
' dwFlags : DWORD
' lpSummary : HEAP_SUMMARY* out
Declare PtrSafe Function HeapSummary Lib "kernel32" ( _
    ByVal hHeap As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lpSummary As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HeapSummary = ctypes.windll.kernel32.HeapSummary
HeapSummary.restype = wintypes.BOOL
HeapSummary.argtypes = [
    wintypes.HANDLE,  # hHeap : HANDLE
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # lpSummary : HEAP_SUMMARY* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
HeapSummary = Fiddle::Function.new(
  lib['HeapSummary'],
  [
    Fiddle::TYPE_VOIDP,  # hHeap : HANDLE
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpSummary : HEAP_SUMMARY* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn HeapSummary(
        hHeap: *mut core::ffi::c_void,  // HANDLE
        dwFlags: u32,  // DWORD
        lpSummary: *mut HEAP_SUMMARY  // HEAP_SUMMARY* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool HeapSummary(IntPtr hHeap, uint dwFlags, IntPtr lpSummary);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_HeapSummary' -Namespace Win32 -PassThru
# $api::HeapSummary(hHeap, dwFlags, lpSummary)
#uselib "KERNEL32.dll"
#func global HeapSummary "HeapSummary" sptr, sptr, sptr
; HeapSummary hHeap, dwFlags, varptr(lpSummary)   ; 戻り値は stat
; hHeap : HANDLE -> "sptr"
; dwFlags : DWORD -> "sptr"
; lpSummary : HEAP_SUMMARY* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global HeapSummary "HeapSummary" sptr, int, var
; res = HeapSummary(hHeap, dwFlags, lpSummary)
; hHeap : HANDLE -> "sptr"
; dwFlags : DWORD -> "int"
; lpSummary : HEAP_SUMMARY* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL HeapSummary(HANDLE hHeap, DWORD dwFlags, HEAP_SUMMARY* lpSummary)
#uselib "KERNEL32.dll"
#cfunc global HeapSummary "HeapSummary" intptr, int, var
; res = HeapSummary(hHeap, dwFlags, lpSummary)
; hHeap : HANDLE -> "intptr"
; dwFlags : DWORD -> "int"
; lpSummary : HEAP_SUMMARY* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procHeapSummary = kernel32.NewProc("HeapSummary")
)

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