RtMonitorSetCustomTriggers

RtMonitorSetCustomTriggers transiently sets the custom event types that will trigger the starting or stopping of a monitoring session.

Syntax

BOOL RtMonitorSetCustomTriggers(
    const RT_MONITOR_CUSTOM_TRIGGER_CONTROL * customEventTriggers,
    size_t countCustomEventTriggers,
    BOOL enable
);

Parameters

customEventTriggers

An array of RT_MONITOR_TRIGGER_CONTROL structures that will either be set or unset as a monitor trigger based on parameter enable.

countCustomEventTriggers

The number of elements in the array.

enable

Determines whether the events are enabled or disabled as trigger events.

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 custom event is greater than MF_TRIGGERS_FOR_CUSTOM_EVENT_IDS_MAX

Requirements

Minimum Supported Version

RTX64 3.6

Header

Rtapi.h

Library

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