RtMonitorGetPreTriggerEventsToSave

RtMonitorGetPreTriggerEventsToSave retrieves 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 RtMonitorGetPreTriggerEventsToSave(
    [in]    uint32_t * pPreTriggerEventsToSave
);

Parameters

[in] pPreTriggerEventsToSave

A pointer to a value that the API will set to be the transient value of the number of pre-start-trigger events to save.

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: