RtMonitorSetMaxEventsInSession sets the transient value of the maximum number of events to collect in a monitoring session.
Syntax
BOOL RtMonitorSetMaxEventsInSession(
[in] uint32_t maxEventsInSession
);Parameters
[in] 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
If the function succeeds, it returns TRUE. If the function fails, 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 | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtApi.h |
RtApi.lib (Windows), Startup.lib (RTSS) |
See Also:
