RtFreeLockedMemory

RtFreeLockedMemory frees memory previously committed and locked by a call to RtAllocateLockedMemory.

NOTE: This function is deprecated and will be removed from a future release. Use RtFreeLocalMemory.

Syntax

BOOL RtFreeLockedMemory(
    PVOID pVirtualAddress
);

Parameters

pVirtualAddress

A pointer to the start of the memory, as returned by RtAllocateLockedMemory.

Return Value

TRUE if the function succeeds, FALSE if the function fails

The table below outlines this function's return values in certain memory configurations between RTX64 4.x and RTX64 3.x:

RTX64 4.x with Local Memory RTX64 4.0 with Windows Memory RTX64 3.x with Local and Windows Memory

Returns true for int memory [new INT(10)]

Returns true for memory allocated by HeapAlloc

Returns true on second free

Fails as expected with NULL parameter

Fails as expected

Fails as expected on second free

Fails as expected with NULL parameter

Fails as expected

Fails as expected on second free

Fails as expected with NULL parameter

Remarks

RtFreeLockedMemory frees memory previously allocated, committed, and locked by RtAllocateLockedMemory.

Requirements

Header RtssApi.h
Library Rtx_Rtss.lib

See Also:

RtAllocateLockedMemory