Expand Minimize

RtlDestroyHeap routine

The RtlDestroyHeap routine destroys the specified heap object. RtlDestroyHeap decommits and releases all the pages of a private heap object, and it invalidates the handle to the heap.

Syntax


PVOID RtlDestroyHeap(
  _In_  PVOID HeapHandle
);

Parameters

HeapHandle [in]

Handle for the heap to be destroyed. This parameter is a heap handle returned by RtlCreateHeap.

Return value

If the call to RtlDestroyHeap succeeds, the return value is a NULL pointer.

If the call to RtlDestroyHeap fails, the return value is a handle for the heap.

Remarks

Processes can call RtlDestroyHeap without first calling RtlFreeHeap to free memory that was allocated from the heap.

Requirements

Version

This routine is available on Microsoft Windows XP and later.

Header

Ntifs.h (include Ntifs.h)

Library

Ntoskrnl.lib

IRQL

< DISPATCH_LEVEL

See also

RtlAllocateHeap
RtlCreateHeap
RtlFreeHeap

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft