HeapWalk

関数

ヒープ内のメモリブロックを順に列挙する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL HeapWalk(
    HANDLE hHeap,
    PROCESS_HEAP_ENTRY* lpEntry
);

パラメーター

名前	型	方向	説明
hHeap	HANDLE	in	ヒープへのハンドル。このハンドルは HeapCreate または GetProcessHeap 関数によって返されます。
lpEntry	PROCESS_HEAP_ENTRY*	inout	特定のヒープ列挙の状態情報を保持する PROCESS_HEAP_ENTRY 構造体へのポインター。 HeapWalk 関数が成功して TRUE を返した場合、この構造体のメンバーにはヒープ内の次のメモリブロックに関する情報が格納されます。ヒープ列挙を開始するには、 PROCESS_HEAP_ENTRY 構造体の lpData フィールドを NULL に設定します。特定のヒープ列挙を継続するには、 hHeap、lpEntry、または PROCESS_HEAP_ENTRY 構造体のメンバーを変更せずに、 HeapWalk 関数を繰り返し呼び出します。

名前

型

方向

説明

hHeap

HANDLE

ヒープへのハンドル。このハンドルは HeapCreate または GetProcessHeap 関数によって返されます。

lpEntry

PROCESS_HEAP_ENTRY*

inout

特定のヒープ列挙の状態情報を保持する PROCESS_HEAP_ENTRY 構造体へのポインター。

HeapWalk 関数が成功して TRUE を返した場合、この構造体のメンバーにはヒープ内の次のメモリブロックに関する情報が格納されます。

ヒープ列挙を開始するには、 PROCESS_HEAP_ENTRY 構造体の lpData フィールドを NULL に設定します。特定のヒープ列挙を継続するには、 hHeap、lpEntry、または PROCESS_HEAP_ENTRY 構造体のメンバーを変更せずに、 HeapWalk 関数を繰り返し呼び出します。

戻り値の型: BOOL

公式ドキュメント

指定されたヒープ内のメモリブロックを列挙します。

戻り値

関数が成功した場合、戻り値は 0 以外です。

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

ヒープの末尾に到達してヒープ列挙が正常に終了した場合、関数は FALSE を返し、GetLastError はエラーコード ERROR_NO_MORE_ITEMS を返します。

解説(Remarks)

HeapWalk 関数は、主にデバッグに役立ちます。ヒープの列挙は時間のかかる可能性のある操作だからです。列挙中にヒープをロックすると、他のスレッドによるヒープへのアクセスがブロックされ、特に対称型マルチプロセッシング (SMP) コンピューターではパフォーマンスが低下する可能性があります。その副作用はヒープのロックが解除されるまで続くことがあります。ヒープ列挙中のヒープロックを制御するには、 HeapLock 関数と HeapUnlock 関数を使用します。

ヒープ列挙を開始するには、lpEntry が指す PROCESS_HEAP_ENTRY 構造体の lpData フィールドを NULL に設定して HeapWalk を呼び出します。

ヒープ列挙を継続するには、同じ hHeap および lpEntry の値で、かつ前回の HeapWalk 呼び出しから変更していない PROCESS_HEAP_ENTRY 構造体を指定して HeapWalk を呼び出します。これ以上列挙する必要がなくなるまで、または関数が FALSE を返し GetLastError が ERROR_NO_MORE_ITEMS を返すまで、この処理を繰り返します。これはヒープのすべてのメモリブロックが列挙されたことを示します。

列挙状態のデータは PROCESS_HEAP_ENTRY 構造体の内容以外には保持されないため、ヒープ列挙を終了するために HeapWalk を特別に呼び出す必要はありません。

マルチスレッドアプリケーションでは、ヒープ列挙中にヒープがロックされていないと HeapWalk が失敗することがあります。

例

ヒープの列挙

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

各言語での呼び出し定義

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

BOOL HeapWalk(
    HANDLE hHeap,
    PROCESS_HEAP_ENTRY* lpEntry
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool HeapWalk(
    IntPtr hHeap,   // HANDLE
    IntPtr lpEntry   // PROCESS_HEAP_ENTRY* in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function HeapWalk(
    hHeap As IntPtr,   ' HANDLE
    lpEntry As IntPtr   ' PROCESS_HEAP_ENTRY* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hHeap : HANDLE
' lpEntry : PROCESS_HEAP_ENTRY* in/out
Declare PtrSafe Function HeapWalk Lib "kernel32" ( _
    ByVal hHeap As LongPtr, _
    ByVal lpEntry As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

HeapWalk = ctypes.windll.kernel32.HeapWalk
HeapWalk.restype = wintypes.BOOL
HeapWalk.argtypes = [
    wintypes.HANDLE,  # hHeap : HANDLE
    ctypes.c_void_p,  # lpEntry : PROCESS_HEAP_ENTRY* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
HeapWalk = Fiddle::Function.new(
  lib['HeapWalk'],
  [
    Fiddle::TYPE_VOIDP,  # hHeap : HANDLE
    Fiddle::TYPE_VOIDP,  # lpEntry : PROCESS_HEAP_ENTRY* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn HeapWalk(
        hHeap: *mut core::ffi::c_void,  // HANDLE
        lpEntry: *mut PROCESS_HEAP_ENTRY  // PROCESS_HEAP_ENTRY* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool HeapWalk(IntPtr hHeap, IntPtr lpEntry);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_HeapWalk' -Namespace Win32 -PassThru
# $api::HeapWalk(hHeap, lpEntry)

#uselib "KERNEL32.dll"
#func global HeapWalk "HeapWalk" sptr, sptr
; HeapWalk hHeap, varptr(lpEntry)   ; 戻り値は stat
; hHeap : HANDLE -> "sptr"
; lpEntry : PROCESS_HEAP_ENTRY* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global HeapWalk "HeapWalk" sptr, var
; res = HeapWalk(hHeap, lpEntry)
; hHeap : HANDLE -> "sptr"
; lpEntry : PROCESS_HEAP_ENTRY* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global HeapWalk "HeapWalk" sptr, sptr
; res = HeapWalk(hHeap, varptr(lpEntry))
; hHeap : HANDLE -> "sptr"
; lpEntry : PROCESS_HEAP_ENTRY* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。