RtfwSetAllMonitorEventStates

RtfwSetAllMonitorEventStates enables or disables all RTX64 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

bool RtfwSetAllMonitorEventStates(
    bool enableAll
);

Parameters

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

The function returns true if it succeeds. Otherwise, it returns false. Call GetLastError for additional error information.

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 RTX64 Subsystem must be restarted for the change to take effect.

Requirements

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

See Also:

RtfwSetMonitorEventStates

MF_EVENT_KIND