HeapFree
The HeapFree
function frees a memory block allocated from a heap by the HeapAlloc or HeapReAlloc function.
BOOL HeapFree(
|
HANDLE hHeap, |
// handle to the
heap |
|
DWORD dwFlags, |
// heap freeing
flags |
|
LPVOID lpMem |
// pointer to the
memory to free |
|
); |
|
Parameters
hHeap
Specifies the
heap whose memory block the function frees. This parameter is a handle returned
by the HeapCreate
or GetProcessHeap
function.
dwFlags
Specifies
several controllable aspects of freeing a memory block. Only one flag is
currently defined; however, all other flag values are reserved for future use.
Specifying this flag will override the corresponding flag specified in the flOptions
parameter when the heap was created by using the HeapCreate function:
|
Flag |
Meaning |
|
HEAP_NO_SERIALIZE |
Specifies
that mutual exclusion will not be used while the function is accessing the
heap. For more information about HEAP_NO_SERIALIZE, see the Remarks for the HeapCreate
function. |
lpMem
Points to the
memory block to free. This pointer is returned by the HeapAlloc or HeapReAlloc
function.
Return Values
If the
function succeeds, the return value is nonzero.
If the
function fails, the return value is zero. An application can call GetLastError for extended error
information.
See Also