RtfwGetMonitorEventStates

RtfwGetMonitorEventStates returns the default enabled/disabled state of the monitoring events that can be generated by the RTX64 Subsystem.

Syntax

bool RtfwGetMonitorEventStates(
    bool * pEventStates,
    size_t * pCountElements
);

Parameters

pEventStates

A pointer to an array containing MF_EVENT_KIND_MAX elements, each of which is set to true if the corresponding event is enabled or false if it is disabled. This array is indexed by MF_EVENT_KIND enumerators.

pCountElements

A pointer to a value that specifies the number of elements in the array pointed to by pEventStates, which must be MF_EVENT_KIND_MAX.

Return Value

The function returns true if it succeeds. Otherwise, it returns false, sets the last error value, and leaves the memory pointed to by both parameters undefined. Call GetLastError for additional error information.

Remarks

If the Subsystem is running when the RtfwSetMonitorEventStates API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

If an event is enabled, it will be generated by the RTX64 Subsystem, otherwise it will not be generated.

After this function succeeds, the value pointed to by pCountElements is set to the number of elements in the array that were set by this function.

If you are running binaries built form a different SDK version, parameter pEventStates will be less than the number of event kinds in the Runtime. This function returns information for only that subset of event kinds. If pEventStates is greater than the number of event kinds in the Runtime, the elements in the array that do not correspond to event kinds in the Runtime are left with invalid data.

If the Subsystem is running when the RtfwGetLocalMemoryConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

Requirements

Minimum Required Version	RTX64 3.4
Header	RtfwAPI.h
Library	RtfwAPI.lib