HeapWalk

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

HeapWalk hHeap, lpEntry

hHeap : [intptr] ヒープへのハンドル。このハンドルは HeapCreate もしくは GetProcessHeap 関数によって返される。
lpEntry : [var] 特定のヒープ列挙の状態情報を保持する PROCESS_HEAP_ENTRY 構造体へのポインタ。HeapWalk 関数が成功して TRUE を返すと、この構造体のメンバにはヒープ内の次のメモリブロックに関する情報が入る。ヒープ列挙を開始するには、PROCESS_HEAP_ENTRY 構造体の lpData フィールドを NULL に設定する。特定のヒープ列挙を続けるには、hHeap、lpEntry、および PROCESS_HEAP_ENTRY 構造体の各メンバを変更せずに HeapWalk 関数を繰り返し呼ぶ。

(プラグイン / モジュール : kernel32.dll)

解説

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

[戻り値]
関数が成功した場合、戻り値は 0 以外となる。関数が失敗した場合、戻り値は 0 となる。拡張エラー情報を取得するには
GetLastError を呼ぶ。ヒープの終端に到達して列挙が正常に終了した場合、関数は FALSE を返し、GetLastError
はエラーコード ERROR_NO_MORE_ITEMS を返す。

[備考]
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
が失敗する可能性がある。

情報