HeapSummary

関数

ヒープの使用状況の概要を取得する。

DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

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

パラメーター

名前	型	方向	説明
hHeap	HANDLE	in	サマリー情報を取得するヒープへのハンドル。このハンドルは、 HeapCreate 関数または GetProcessHeap 関数によって返されます。
dwFlags	DWORD	in	ヒープサマリーのオプション。現在オプションは定義されていません。このパラメーターにはゼロを渡してください。
lpSummary	HEAP_SUMMARY*	out	情報を受け取る HEAP_SUMMARY 構造体へのポインター。この関数を呼び出す前に、cbSize メンバーに `sizeof(HEAP_SUMMARY)` を設定する必要があることに注意してください。

戻り値の型: BOOL

公式ドキュメント

HeapSummary 関数 (heapapi.h) は、指定したヒープのサマリー情報を取得します。

戻り値

成功した場合は TRUE、失敗した場合は FALSE を返します。

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

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global HeapSummary "HeapSummary" sptr, int, sptr
; res = HeapSummary(hHeap, dwFlags, varptr(lpSummary))
; hHeap : HANDLE -> "sptr"
; dwFlags : DWORD -> "int"
; lpSummary : HEAP_SUMMARY* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。