HeapSize

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function returns the size, in bytes, of a memory block allocated from a heap by the HeapAlloc or HeapReAlloc function.

Syntax

DWORD HeapSize(
  HANDLE hHeap,
  DWORD dwFlags,
  LPCVOID lpMem
);

Parameters

  • hHeap
    [in] Handle to the heap in which the memory block resides.

    This handle is returned by the HeapCreate or GetProcessHeap function.

  • dwFlags
    [in] Controllable aspects of accessing the memory block.

    Only one flag is currently defined; however, all other flag values are reserved for future use.

    Specifying HEAP_NO_SERIALIZE overrides the corresponding flag specified in the flOptions parameter if the heap was created using the HeapCreate function.

    Specifies that mutual exclusion is not used while HeapSize is accessing the heap.

    Do not specify this flag when accessing the process heap. The system might create additional threads within the application's process that simultaneously access the process heap.

    This flag is ignored.

  • lpMem
    [in] Valid pointer to the memory block whose size the function will obtain.

    This is a pointer returned by the HeapAlloc or HeapReAlloc function.

Return Value

In the debug configuration, where heap sentinels are enabled, the return value is the exact allocation size for the heap item.

In the retail configuration, where debug information is not included, the return value is the allocation size aligned to the block size (32 bytes).

0xFFFFFFFF indicates failure. The function does not call SetLastError.

Remarks

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, but it must be used when multiple threads allocate and free memory from the same heap.

A critical section is always used to serialize access to an individual heap. There is a critical section per heap to protect access to each heap.

An attempt to grab a critical section that is not owned is a fast path operation that incurs little overhead. This is similar to using the HEAP_NO_SERIALIZE flag if only one thread was ever accessing a particular heap.

If there is contention for the critical section, and therefore the heap, a new thread request to allocate heap space will serialize.

Requirements

Header winbase.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

Memory Management Functions
GetProcessHeap
HeapAlloc
HeapCreate
HeapDestroy
HeapFree
HeapReAlloc
SetLastError