HeapDestroy function
Destroys the specified heap object. It decommits and releases all the pages of a private heap object, and it invalidates the handle to the heap.
Syntax
BOOL WINAPI HeapDestroy( _In_ HANDLE hHeap );
Parameters
- hHeap [in]
-
A handle to the heap to be destroyed. This handle is returned by the HeapCreate function. Do not use the handle to the process heap returned by the GetProcessHeap function.
Return value
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
Remarks
Processes can call HeapDestroy without first calling the HeapFree function to free memory allocated from the heap.
Examples
Requirements
|
Minimum supported client | Windows XP [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2003 [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also
Send comments about this topic to Microsoft
Build date: 10/26/2012
