Subsystem.GetPreTriggerEventsToSave Method

Retrieves the persistent or 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.

Namespace:  IntervalZero.MaxRT.wRTOS.Monitor
Assembly:  IntervalZero.MaxRT.wRTOS (in IntervalZero.MaxRT.wRTOS.dll) Version: 1.0.0.0 (File version: 1.0.0)

Syntax

Copy
public uint GetPreTriggerEventsToSave(
    bool persistent
)

Parameters

persistent

Type: Boolean

If true, this method returns the persistent number of pre-start-trigger events to save in a monitor session. If false, this method returns the transient number of pre-start-trigger events to save in a monitor session

Return Value

If parameter persistent is true, this method returns the persistent number of pre-start-trigger events to save in a monitor session.

If parameter persistent is false, this method returns the transient number of pre-start-trigger events to save in a monitor session. If the Subsystem is not started, an exception is thrown.

Implements

IMonitorSubsystem.GetPreTriggerEventsToSave (uint)

Exceptions

Exception Condition

wRTOSException

Thrown if this method is used without the wRTOS Runtime installed.

See Also: