RtCommitLockHeap

RtCommitLockHeap commits and locks the heap to avoid page faults as the heap is used.

Syntax

BOOL RtCommitLockHeap(
    HANDLE hHeap,
    ULONG nNumberOfBytes,
    VOID (RTFCNDCL *pExceptionRoutine)(HANDLE)
);

Parameters

hHeap

A handle to the heap to be committed and locked.

nNumberOfBytes

The number of bytes in the heap to lock.

pExceptionRoutine (ignored)

The exception routine to call if the heap uses more than the locked amount.

Return Values

TRUE if the function completes successfully, FALSE if invalid parameters are specified

Remarks

RtCommitLockHeap commits and locks the specified heap in physical memory so that it does not incur page faults as the memory is used, and the memory used for the heap is not paged out by the system.

Since all RTSS heaps are always locked, this function has no effect in the RTSS environment.

Requirements

Header	Rtapi.h
Library	rtapi_w32.lib (Windows), Rtx_Rtss.lib (RTSS)