RtQueryProcessMSpace

RtQueryProcessMSpace queries memory allocation space information for the specified process MSpace, including various summary statistics of its local pool and pool cache.

Syntax

Copy

BOOL RtQueryProcessMSpace(
    [in]    mspace MSpace,
    [out]   MSPACE_INFO *MSpaceInfo,
    [in]    PERFORMANCE_LEVEL PerformanceLevel
);

Parameters

[in] MSpace

A descriptor to the external or internal MSpace of the RTSS process, as returned by RtGetProcessMSpace. If NULL is specified, the external MSpace of the current process is queried. Passing NULL for this parameter is only valid when this API is called from a real-time process. If a Windows process passes NULL for this parameter, the API will fail and set the last error value to ERROR_INVALID_PARAMETER.

[out] MSpaceInfo

A pointer to the structure MSPACE_INFO to store the information of the specified MSpace.

[in] PerformanceLevel

An enum value of a PERFORMANCE_LEVEL enum structure that indicates the performance level of calling RtQueryProcessMSpace.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE.

Remarks

Calling RtQueryProcessMSpace in a Windows process with the MSpace parameter set to NULL will return information about the associated proxy process’ external MSpace.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtApi.h	RtApi.lib (Windows), Startup.lib (RTSS)