RtMonitorSetMaxEventsInSession

RtMonitorSetMaxEventsInSession sets the transient value of the maximum number of events to collect in a monitoring session.

Syntax

BOOL RtMonitorSetMaxEventsInSession(
    uint32_t maxEventsInSession
);

Parameters

maxEventsInSession

The maximum number of events to save in a monitoring session.

This value must not be 0, and may be set to the maximum size of an unsigned __int32 (e.g. UINT32_MAX or 0xFFFFFFFF) to represent unlimited events. The maximum number of events to save must not be less than the number of pre-trigger events.

Return Value

Returns true if successful, otherwise it returns false and sets the last error value.

Remarks

If a monitoring session is already in progress, lowering this value may cause monitoring to stop, if the monitoring stop behavior is set to Automatic, or lose saved data is stop behavior is set to Manual.

Requirements

Minimum Supported Version	RTX64 4.2
Header	Rtapi.h
Library	rtx_rtss.lib (RTSS), rtapi.h (Windows)