HeapCompact

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function attempts to compact a specified heap by coalescing adjacent free blocks of memory and decommitting large free blocks of memory.

Syntax

UINT HeapCompact(
  HANDLE hHeap,
  DWORD dwFlags
);

Parameters

• hHeap
  [in] Handle to the heap to be compacted.

  This parameter is a handle returned by the HeapCreate or GetProcessHeap function.

• dwFlags
  [in] Heap access options. The possible value, HEAP_NO_SERIALIZE, is ignored. The heap is always serialized.

Return Value

The size of the largest committed free block in the heap, in bytes, indicates success. Zero indicates failure. To get extended error information, call GetLastError.

In the unlikely case that there is no space available in the heap, the function return value is zero, and GetLastError returns the value NO_ERROR.

Remarks

There is no guarantee that an application can successfully allocate a memory block of the size returned by HeapCompact. Other threads or the commit threshold might prevent such an allocation.

Requirements

See Also

Reference

Memory Management Functions
GetLastError
GetProcessHeap
HeapCreate