This topic has not yet been rated - Rate this topic

LocalSize function

Applies to: desktop apps only

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

UINT WINAPI LocalSize(
  __in  HLOCAL hMem
);

Parameters

hMem [in]

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

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Winbase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Global and Local Functions
LocalAlloc
LocalFlags
LocalHandle
LocalReAlloc
Memory Management Functions

 

 

Send comments about this topic to Microsoft

Build date: 2/7/2012

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ