Export (0) Print
Expand All
Expand Minimize

HeapUnlock function

Releases ownership of the critical section object, or lock, that is associated with a specified heap. It reverses the action of the HeapLock function.

Syntax


BOOL WINAPI HeapUnlock(
  _In_  HANDLE hHeap
);

Parameters

hHeap [in]

A handle to the heap to be unlocked. This handle is returned by either the HeapCreate or GetProcessHeap function.

Return value

If the function succeeds, the return value is nonzero.

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

Remarks

The HeapLock function is primarily useful for preventing the allocation and release of heap memory by other threads while the calling thread uses the HeapWalk function. The HeapUnlock function is the inverse of HeapLock.

Each call to HeapLock must be matched by a corresponding call to the HeapUnlock function. Failure to call HeapUnlock will block the execution of any other threads of the calling process that attempt to access the heap.

If the HeapUnlock function is called on a heap created with the HEAP_NO_SERIALIZATION flag, the results are undefined.

Examples

Enumerating a Heap

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

HeapApi.h (include Windows.h);
WinBase.h on Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Heap Functions
HeapLock
HeapWalk
Memory Management Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft