RtQueryLocalMemory

RtQueryLocalMemory returns RTSS local memory pool information, including the pool size as a whole, the free memory size available, and the maximum virtually contiguous free memory size.

NOTE: RtQueryLocalMemory is only supported in the RTSS environment. It cannot be called from a Windows application linked to RTX64.

Syntax

BOOL RtQueryLocalMemory(
    PULONG MemSize,
    PULONG MemAvail,
    PULONG MemContig
);

Parameters

MemSize

A pointer to an unsigned long returned with the RTSS memory pool size in bytes as a whole, including free and allocated memory

MemAvail

A pointer to an unsigned long returned with the free memory size (in bytes) available in the RTSS memory pool

MemContig

A pointer to an unsigned long returned with the maximum free memory size (in bytes), which is virtually contiguous, in RTSS memory pool

Return Value

TRUE if the function succeeds, FALSE otherwise

Remarks

Applications must link to rtapi.lib.

Requirements

Minimum Supported Version	RTX64 2013
Header	Rtapi.h
Library	RtApi.lib (Windows), Rtx_Rtss.lib (RTSS)