RtMonitorSetEvents

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

Syntax

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

Parameters

eventKinds

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

countEventKinds

The number of elements in the eventKinds array.

enable

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

Return Value

Returns TRUE if successful, otherwise 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

RTX64 3.6

Header

Rtapi.h

Library

rtx_rtss.lib (RTSS), rtapi.h (Windows)