RtMonitorSetPreTriggerEventsToSave

RtMonitorSetPreTriggerEventsToSave sets the transient value of the number of pre-start-trigger events to save in a monitor session. Pre-start-trigger events are events that occur before the event that triggers the start of a monitoring session.

Syntax

Copy
BOOL RtMonitorSetPreTriggerEventsToSave(
    [in]    uint32_t preTriggerEventsToSave
);

Parameters

[in] preTriggerEventsToSave

Sets the transient value of the number of pre-start-trigger events to save.

The number of pre-start-trigger events to save must not exceed the maximum number of events to save in a given session.

Return Value

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

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtApi.h

RtApi.lib (Windows), Startup.lib (RTSS)

See Also: