RtMonitorSetCustomTriggers transiently sets the custom event types that will trigger the starting or stopping of a monitoring session.
Syntax
BOOL RtMonitorSetCustomTriggers(
[in] const RT_MONITOR_CUSTOM_TRIGGER_CONTROL * customEventTriggers,
[in] size_t countCustomEventTriggers,
[in] BOOL enable
);Parameters
[in] customEventTriggers
An array of RT_MONITOR_TRIGGER_CONTROL structures that will either be set or unset as a monitor trigger based on parameter enable.
[in] countCustomEventTriggers
The number of elements in the array.
[in] enable
Determines whether the events are enabled or disabled as trigger events.
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 custom event is greater than MF_TRIGGERS_FOR_CUSTOM_EVENT_IDS_MAX |
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtApi.h |
RtApi.lib (Windows), Startup.lib (RTSS) |
See Also:
