RtfwGetMonitorComponents

RtfwGetMonitorComponents returns the enabled wRTOS Monitoring components.

Syntax

Copy

bool RtfwGetMonitorComponents(
    [out]   PRT_MONITOR_COMPONENT componentsEnabled
);

Parameters

[out] componentsEnabled

A pointer to an RT_MONITOR_COMPONENT enumeration that represents wRTOS product components that can have their monitoring event generation enabled/disabled persistently or transiently.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE, sets the last error value, and leaves the structure pointed to with invalid data. Call GetLastError to obtain an error code.

Remarks

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

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtfwApi.h	RtfwApi.lib