Export (0) Print
Expand All
Expand Minimize

HeapCompact function

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.

Syntax


SIZE_T WINAPI HeapCompact(
  _In_  HANDLE hHeap,
  _In_  DWORD dwFlags
);

Parameters

hHeap [in]

A handle to the heap. This handle is returned by either the HeapCreate or GetProcessHeap function.

dwFlags [in]

The heap access options. This parameter can be the following value.

ValueMeaning
HEAP_NO_SERIALIZE
0x00000001

Serialized access will not be used. For more information, see Remarks.

To ensure that serialized access is disabled for all calls to this function, specify HEAP_NO_SERIALIZE in the call to HeapCreate. In this case, it is not necessary to additionally specify HEAP_NO_SERIALIZE in this function call.

Do not specify this value when accessing the process heap. The system may create additional threads within the application's process, such as a CTRL+C handler, that simultaneously access the process heap.

 

Return value

If the function succeeds, the return value is the size of the largest committed free block in the heap, in bytes.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

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

Remarks

The HeapCompact function is primarily useful for debugging. Ordinarily, the system compacts the heap whenever the HeapFree function is called, and the HeapCompact function returns the size of the largest free block in the heap but does not compact the heap any further. If the Disable heap coalesce on free global flag is set during debugging, the system does not compact the heap and calling the HeapCompact function does compact the heap. For more information about global flags, see the GFlags documentation.

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.

Serialization ensures mutual exclusion when two or more threads attempt to simultaneously allocate or free blocks from the same heap. There is a small performance cost to serialization, but it must be used whenever multiple threads allocate and free memory from the same heap. Setting the HEAP_NO_SERIALIZE value eliminates mutual exclusion on the heap. Without serialization, two or more threads that use the same heap handle might attempt to allocate or free memory simultaneously, likely causing corruption in the heap. The HEAP_NO_SERIALIZE value can, therefore, be safely used only in the following situations:

  • The process has only one thread.
  • The process has multiple threads, but only one thread calls the heap functions for a specific heap.
  • The process has multiple threads, and the application provides its own mechanism for mutual exclusion to a specific heap.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

HeapApi.h (include Windows.h);
WinBase.h on Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Heap Functions
HeapCreate
HeapValidate
Memory Management Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft