HeapSummary function (heapapi.h)

Summarizes the specified heap.

Syntax

BOOL HeapSummary(
  HANDLE         hHeap,
  DWORD          dwFlags,
  LPHEAP_SUMMARY lpSummary
);

Parameters

hHeap

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

dwFlags

The heap summary options.

lpSummary

Receives a pointer to a Heap_Summary structure representing the heap summary.

Return value

Returns S_OK on success.

Requirements

Requirement Value
Minimum supported client Windows 10 Build 20348
Minimum supported server Windows 10 Build 20348
Header heapapi.h
Library kernel32.lib
DLL kernel32.dll