HeapSummary function (heapapi.h)

Summarizes the specified heap.

Syntax

BOOL HeapSummary(
  [in]      HANDLE         hHeap,
  [in]      DWORD          dwFlags,
  [in, out] LPHEAP_SUMMARY lpSummary
);

Parameters

[in] hHeap

A handle to the heap to be summarized. This handle is returned by either the HeapCreate or GetProcessHeap function.

[in] dwFlags

The heap summary options. No options are currently defined, pass zero for this parameter.

[in, out] lpSummary

A pointer to a HEAP_SUMMARY structure that receives the information. Note that you must set the cbSize member to sizeof(HEAP_SUMMARY) before calling this function.

Return value

Returns TRUE on success, FALSE on failure.

Requirements