RtfwGetMonitorConfiguration

RtfwGetMonitorConfiguration returns the most-recently configured RTX64 Monitoring configuration parameters.

Syntax

bool RtfwGetMonitorConfiguration(
    RTFW_MONITOR_CONFIGURATION * pMonitorConfiguration
);

Parameters

pMonitorConfiguration

A pointer to a structure RTFW_MONITOR_CONFIGURATION that is set to the default Monitoring configuration. The member Size must be set to sizeof(RTFW_MONITOR_CONFIGURATION), otherwise this function fails and sets the last error value to RT_ERROR_STRUCTURE_TOO_SMALL.

Return Value

The function returns true if it succeeds. Otherwise, it returns false, sets the last error value, and leaves the structure pointed to with invalid data. Call GetLastError for additional error information.

Possible error codes:

Error Code	Meaning
RT_ERROR_STRUCTURE_TOO_SMALL	The Size member of a structure is too small.

Remarks

If the Subsystem is running when the RtfwSetMonitorConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

If the Subsystem is running when the RtfwGetLocalMemoryConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

Requirements

Minimum Required Version	RTX64 3.4
Header	RtfwAPI.h
Library	RtfwAPI.lib