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

BOOL RtMonitorGetPreTriggerEventsToSave(
    uint32_t * pPreTriggerEventsToSave
);

Parameters

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

Returns TRUE if successful, otherwise it returns FALSE and sets the last error value.

Requirements

Minimum Supported Version

RTX64 4.2

Header

Rtapi.h

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

See Also: