The LocalAlloc function allocates the specified number of bytes from the heap. In the linear Win32 API environment, there is no difference between the local heap and the global heap.
HLOCAL LocalAlloc(
| UINT uFlags, | // allocation attributes |
| UINT uBytes | // number of bytes to allocate |
| ); |
Parameters
uFlags
Specifies how to allocate memory. If zero is specified, the default is the LMEM_FIXED flag. Except for the incompatible combinations that are specifically noted, any combination of the following flags can be specified. To indicate whether the function allocates fixed or movable memory, specify one of the first six flags:
| Flag | Meaning | ||||
| LMEM_FIXED | |||||
| Allocates fixed memory. This flag cannot be combined with the LMEM_MOVEABLE or LMEM_DISCARDABLE flag. The return value is a pointer to the memory block. To access the memory, the calling process simply casts the return value to a pointer. | |||||
| LMEM_MOVEABLE | |||||
| Allocates movable memory. This flag cannot be combined with the LMEM_FIXED flag. The return value is the handle of the memory object. The handle is a 32-bit quantity that is private to the calling process. To translate the handle into a pointer, use the LocalLock function. | |||||
| LPTR | |||||
| Combines the LMEM_FIXED and LMEM_ZEROINIT flags. | |||||
| LHND | |||||
| Combines the LMEM_MOVEABLE and LMEM_ZEROINIT flags. | |||||
| NONZEROLHND | |||||
| Same as the LMEM_MOVEABLE flag. | |||||
| NONZEROLPTR | |||||
| Same as the LMEM_FIXED flag. | |||||
| LMEM_DISCARDABLE | |||||
| Allocates discardable memory. This flag cannot be combined with the LMEM_FIXED flag. Some Win32-based applications may ignore this flag. | |||||
| LMEM_NOCOMPACT | |||||
| Does not compact or discard memory to satisfy the allocation request. | |||||
| LMEM_NODISCARD | |||||
| Does not discard memory to satisfy the allocation request. | |||||
| LMEM_ZEROINIT | |||||
| Initializes memory contents to zero. | |||||
uBytes
Specifies the number of bytes to allocate. If this parameter is zero and the uFlags parameter specifies the LMEM_MOVEABLE flag, the function returns a handle to a memory object that is marked as discarded.
Return Values
If the function succeeds, the return value is the handle of the newly allocated memory object.
If the function fails, the return value is NULL. To get extended error information, call GetLastError.
Remarks
If the heap does not contain sufficient free space to satisfy the request, LocalAlloc returns NULL.
The GlobalAlloc and LocalAlloc functions are limited to a combined total of 65,536 handles for GMEM_MOVEABLE and LMEM_MOVEABLE memory per process. This limitation does not apply to GMEM_FIXED or LMEM_FIXED memory.
If this function succeeds, it allocates at least the amount requested. If the amount allocated is greater than the amount requested, the process can use the entire amount. To determine the actual number of bytes allocated, use the LocalSize function.
See Also