LocalDiscard

The LocalDiscard function discards the specified local memory object. The lock count of the memory object must be zero.

This function is provided only for compatibility with 16-bit versions of Windows.

HLOCAL LocalDiscard(
  HLOCAL hlocMem   // handle to local memory object
);
 

Parameters

hlocMem

Handle to the local memory object. This handle is returned by either the LocalAlloc or LocalReAlloc function.

Return Values

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

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

Remarks

Although LocalDiscard discards the object's memory block, the handle to the object remains valid. A process can subsequently pass the handle to the LocalReAlloc function to allocate another local memory object identified by the same handle.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winbase.h.

See Also

Memory Management Overview, Memory Management Functions, LocalAlloc, LocalReAlloc