Subsystem.GetMaxEventsInSession Method

Retrieves the persistent or transient value of the number of events to save in a monitor session.

Namespace:  IntervalZero.RTX64.Monitor
Assembly:  IntervalZero.RTX64 (in IntervalZero.RTX64.dll) Version: 4.0.0.0 (File version: 4.5.0)

Syntax
Copy
public uint GetMaxEventsInSession(
	bool persistent
)

Parameters

persistent

Type: Boolean

If TRUE, this method returns the persistent number of events to save in a monitor session. If FALSE, this method returns the transient number of events to save in a monitor session.

Return Values

If parameter persistent is TRUE, this method returns the persistent number of events to save in a monitor session.

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

If the returned value equals the constant IntervalZero.RTX64.Monitor.Subsystem.UnlimitedMaxEventsInSession (0xFFFFFFFF), an unlimited number of events will be saved.

Implements

IMonitorSubsystem.GetMaxEventsInSession(uint)
Exceptions
ExceptionCondition
RTX64Exception Thrown if this method is used without the RTX64 Runtime installed.
See Also