HeapDestroy

HeapDestroy destroys the specified heap object. It uncommits and releases all the pages of a private heap object and it invalidates the handle of the heap.

Syntax

BOOL HeapDestroy(
    HANDLE hHeap
);

Parameters

hHeap

The heap to be destroyed. This parameter should be a heap handle returned by HeapCreate. A heap handle returned by GetProcessHeap should not be used.

Return Value

TRUE if the function succeeds, FALSE if the function fails

To get extended error information, call GetLastError.

Remarks

Processes can call HeapDestroy without first calling HeapFree to free memory allocated from the heap.

Requirements

Minimum Supported Version	RTX64 2013
Header	windows.h
Library	Rtx_Rtss.lib