RtfwSetAllMonitorEventStates

RtfwSetAllMonitorEventStates enables or disables all wRTOS Monitoring events. If a given monitoring event is enabled, it will be generated and stored in a monitoring session folder when the corresponding real-time Subsystem operation occurs. If a given monitoring event is disabled, it will not be generated.

Syntax

Copy

bool RtfwSetAllMonitorEventStates(
    [in]    bool enableAll
);

Parameters

[in] enableAll

If TRUE, all monitoring events will be enabled, otherwise all monitoring events will be disabled (except for MF_EVENT_KIND_MARKER and MF_EVENT_KIND_DATALOST, which can never be disabled).

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

Possible error codes:

Error code	Meaning
RT_ERROR_RESTART_SUBSYSTEM	The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the Subsystem must be restarted. Note: The wRTOS Subsystem must be restarted for the change to take effect.

Error code

Meaning

RT_ERROR_RESTART_SUBSYSTEM

The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the Subsystem must be restarted.

Note: The wRTOS Subsystem must be restarted for the change to take effect.

Requirements

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