heapapi.h header

This header is used by System Services. For more information, see:

• System Services

heapapi.h contains the following programming interfaces:

Functions

GetProcessHeap Retrieves a handle to the default heap of the calling process.
GetProcessHeaps Returns the number of active heaps and retrieves handles to all of the active heaps for the calling process.
HeapAlloc Allocates a block of memory from a heap. The allocated memory is not movable.
HeapCompact Returns the size of the largest committed free block in the specified heap. If the Disable heap coalesce on free global flag is set, this function also coalesces adjacent free blocks of memory in the heap.
HeapCreate Creates a private heap object that can be used by the calling process. The function reserves space in the virtual address space of the process and allocates physical storage for a specified initial portion of this block.
HeapDestroy 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.
HeapFree Frees a memory block allocated from a heap by the HeapAlloc or HeapReAlloc function.
HeapLock Attempts to acquire the critical section object, or lock, that is associated with a specified heap.
HeapQueryInformation Retrieves information about the specified heap.
HeapReAlloc Reallocates a block of memory from a heap. This function enables you to resize a memory block and change other memory block properties.
HeapSetInformation Enables features for a specified heap.
HeapSize Retrieves the size of a memory block allocated from a heap by the HeapAlloc or HeapReAlloc function.
HeapSummary The HeapSummary function (heapapi.h) summarizes the specified heap.
HeapUnlock Releases ownership of the critical section object, or lock, that is associated with a specified heap.
HeapValidate Validates the specified heap. The function scans all the memory blocks in the heap and verifies that the heap control structures maintained by the heap manager are in a consistent state.
HeapWalk Enumerates the memory blocks in the specified heap.

Structures

HEAP_SUMMARY The HEAP_SUMMARY structure (heapapi.h) represents a heap summary retrieved with a call to the HeapSummary function.