RtMonitorSetEvents

RtMonitorSetEvents transiently enables or disables collection of events during a monitoring session.

Syntax

Copy

BOOL RtMonitorSetEvents(
    [in]    const MF_EVENT_KIND * eventKinds,
    [in]    size_t countEventKinds,
    [in]    BOOL enable
);

Parameters

[in] eventKinds

An array of MF_EVENT_KIND events that determines which events will be collected during a monitor session.

[in] countEventKinds

The number of elements in the eventKinds array.

[in] enable

Determines whether you are enabling or disabling the provided events to be recorded during a monitor session.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE and sets the last error value.

Possible error codes:

Error code	Meaning
RT_ERROR_UNKNOWN_MONITORING_EVENT	The value of parameter eventKind is equal to or greater than MF_EVENT_KIND_MAX.

Requirements

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