HeapCompact

指定したヒープ内でコミット済みの最大の空きブロックのサイズを返す。Disable heap coalesce on free グローバルフラグが設定されている場合、この関数はヒープ内の隣接する空きメモリブロックも結合する。

HeapCompact hHeap, dwFlags

hHeap : [intptr] ヒープのハンドル。このハンドルは HeapCreate または GetProcessHeap 関数によって返される。
dwFlags : [int] ヒープアクセスオプション。このパラメータには以下の値を指定できる。

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

解説

指定したヒープ内でコミット済みの最大の空きブロックのサイズを返す。Disable heap coalesce on free
グローバルフラグが設定されている場合、この関数はヒープ内の隣接する空きメモリブロックも結合する。

[戻り値]
関数が成功した場合、戻り値はヒープ内でコミット済みの最大の空きブロックのサイズ（バイト単位）となる。関数が失敗した場合、戻り値は 0
となる。拡張エラー情報を取得するには GetLastError を呼ぶ。ヒープにまったく空き領域が無いという稀なケースでは、関数の戻り値は
0 となり、GetLastError は NO_ERROR を返す。

[備考]
HeapCompact 関数は主にデバッグ用に使われる。通常、システムは HeapFree
関数が呼ばれるたびにヒープをコンパクションし、HeapCompact
関数はヒープ内で最大の空きブロックのサイズを返すだけで、それ以上のコンパクションは行わない。デバッグ中に Disable heap
coalesce on free グローバルフラグが設定されている場合、システムはヒープをコンパクションしないため、HeapCompact
関数を呼ぶとヒープをコンパクションする。グローバルフラグの詳細は GFlags のドキュメントを参照のこと。アプリケーションが
HeapCompact
の返すサイズのメモリブロックを必ず確保できるとは限らない。他のスレッドやコミットしきい値によって確保が妨げられることがある。シリアライゼーションは、2
つ以上のスレッドが同じヒープから同時にブロックを確保・解放しようとしたときに相互排他を保証する。シリアライゼーションには若干のパフォーマンスコストがあるが、複数のスレッドが同じヒープからメモリを確保・解放する場合は必ず使わなければならない。HEAP_NO_SERIALIZE
値を設定するとヒープ上の相互排他が無効になる。シリアライゼーションなしで同じヒープハンドルを使う 2
つ以上のスレッドが同時にメモリを確保・解放しようとすると、ヒープが破壊される可能性が高い。したがって HEAP_NO_SERIALIZE
値を安全に使えるのは次の状況に限られる:
（以下省略）

情報