Subsystem.SetMaxEventsInSession Method

Sets the transient value of the number of events to save in a monitor 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 void SetMaxEventsInSession(
    uint count
    bool persistent
)

Parameters

persistent

Type: Boolean
If true, this method sets the persistent number of events to save in a monitor session to count. If false, this method sets the transient number of events to save in a monitor session to count.

count

Type: Uint32
The number of events to save in a monitor session. If this value equals the constant IntervalZero.MaxRT.wRTOS.Monitor.Subsystem.UnlimitedMaxEventsInSession (0xFFFFFFFF), this API sets maximum number of monitor events in a session to unlimited.

Return Value

If parameter persistent is true, this method sets the persistent number of events to save in a monitor session to count.

If parameter persistent is false, this method sets the transient number of events to save in a monitor session to count. If the Subsystem is not started, an exception is thrown.

Implements

IMonitorSubsystem.SetMaxEventsInSession (uint)

Exceptions

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