LocalDiscard macro (minwinbase.h)

Article
02/22/2024

Discards the specified local memory object. The lock count of the memory object must be zero.

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

void LocalDiscard(
  [in]  h
);

Parameters

[in] h

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

Return value

None

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.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	minwinbase.h (include Windows.h)