This topic has not yet been rated - Rate this topic

LocalHandle function

Applies to: desktop apps only

Retrieves the handle associated with the specified pointer to a local memory object.

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

Copy

HLOCAL WINAPI LocalHandle(
  __in  LPCVOID pMem
);

Parameters

pMem [in]: A pointer to the first byte of the local memory object. This pointer is returned by the LocalLock function.

Return value

If the function succeeds, the return value is a handle to the specified local memory object.

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

Remarks

When the LocalAlloc function allocates a local memory object with LMEM_MOVEABLE, it returns a handle to the object. The LocalLock function converts this handle into a pointer to the object's memory block, and LocalHandle converts the pointer back into a handle.

Requirements