2 out of 2 rated this helpful - Rate this topic

HeapDestroy function

Applies to: desktop apps only

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

Enumerating a Heap

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Winbase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Heap Functions
HeapCreate
Memory Management Functions

 

 

Send comments about this topic to Microsoft

Build date: 2/7/2012

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ