RtMonitorGetMaxEventsInSession

RtMonitorGetMaxEventsInSession retrieves the transient value of the maximum number of events to collect in a monitoring session.

Syntax

Copy
BOOL RtMonitorGetMaxEventsInSession(
    uint32_t * pMaxEventsInSession
);

Parameters

[in] pMaxEventsInSession

A pointer to a value that the API will set to be the transient value of the maximum number of events to collect in a monitoring session.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE and sets the last error value.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtApi.h

RtApi.lib (Windows), Startup.lib (RTSS)

See Also: