LocalSize function (winbase.h)

Article
02/22/2024

Retrieves the current size of the specified local memory object, in bytes.

Note The local functions have greater overhead and provide fewer features than other memory management functions. New applications should use the heap functions unless documentation states that a local function should be used. For more information, see Global and Local Functions.

Syntax

SIZE_T LocalSize(
  [in] HLOCAL hMem
);

Parameters

[in] hMem

A handle to the local memory object. This handle is returned by the LocalAlloc, LocalReAlloc, or LocalHandle function.

Return value

If the function succeeds, the return value is the size of the specified local memory object, in bytes. If the specified handle is not valid or if the object has been discarded, the return value is zero. To get extended error information, call GetLastError.

Remarks

The size of a memory block may be larger than the size requested when the memory was allocated.

To verify that the specified object's memory block has not been discarded, call the LocalFlags function before calling LocalSize.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	winbase.h (include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll