Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.25 KB

HeapLock.md

File metadata and controls

52 lines (34 loc) · 1.25 KB

Home

Function name : HeapLock

Group: Memory Management - Library: kernel32

Attempts to acquire the critical section object, or lock, that is associated with a specified heap.

Code examples:

Obtaining heap handles and enumerating memory blocks for the current VFP session (WinNT only)

Declaration:

BOOL HeapLock(
  HANDLE hHeap   // handle to heap
);

FoxPro declaration:

DECLARE INTEGER HeapLock IN kernel32;
	INTEGER hHeap

Parameters:

hHeap [in] Handle to the heap to lock for exclusive access by the calling thread.

Return value:

If the function succeeds, the return value is nonzero.

Comments:

Windows NT/2000/XP: Included in Windows NT 3.5 and later.
Windows 95/98/Me: Unsupported.

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.

Each call to HeapLock must be matched by a corresponding call to the HeapUnlock function.