Platform SDK: Memory |
The LocalFlags function returns information about the specified local memory object.
Note This function is provided only for compatibility with 16-bit versions of Windows.
UINT LocalFlags( HLOCAL hMem // handle to local memory object );
If the function succeeds, the return value specifies the allocation values and the lock count for the memory object.
If the function fails, the return value is LMEM_INVALID_HANDLE, indicating that the local handle is not valid. To get extended error information, call GetLastError.
The low-order byte of the low-order word of the return value contains the lock count of the object. To retrieve the lock count from the return value, use the LMEM_LOCKCOUNT mask with the bitwise AND (&) operator. The lock count of memory objects allocated with LMEM_FIXED is always zero.
The high-order byte of the low-order word of the return value indicates the allocation values of the memory object. It can be zero or a combination of the following values.
Value | Description |
---|---|
LMEM_DISCARDABLE | Ignored. This value is provided only for compatibility with 16-bit Windows.
In Win32, you must explicitly call the LocalDiscard function to discard a block. |
LMEM_DISCARDED | The object's memory block has been discarded. |
Windows NT/2000: Requires Windows NT 3.1 or later.
Windows 95/98: Requires Windows 95 or later.
Header: Declared in Winbase.h; include Windows.h.
Library: Use Kernel32.lib.
Memory Management Overview, Memory Management Functions, GlobalFlags, LocalAlloc, LocalDiscard, LocalLock, LocalReAlloc, LocalUnlock