This function frees the specified local memory object and invalidates its handle.
At a Glance
| Header file: | Winbase.h |
| Windows CE versions: | 1.0 and later |
Syntax
HLOCAL LocalFree(HLOCAL hMem);
Parameters
hMem
Handle to the local memory object. This handle is returned by either the LocalAlloc or LocalReAlloc function.
Return Values
NULL indicates success. A handle to the local memory object indicates failure. To get extended error information, call GetLastError.
Remarks
If the process tries to examine or modify the memory after it has been freed, heap corruption may occur or an access violation exception (EXCEPTION_ACCESS_VIOLATION) may be generated.
If the hMem parameter is NULL, LocalFree ignores the parameter and returns NULL.
The LocalFree function will free a locked memory object. A locked memory object has a lock count greater than zero.
If an application is running under a debug version of the system, LocalFree issues a message that tells you that a locked object is being freed. If you are debugging the application, LocalFree enters a breakpoint just before freeing a locked object. This allows you to verify the intended behavior, then continue execution.
See Also