RtfwSetMonitorComponents

RtfwSetMonitorComponents returns the enabled wRTOS Monitoring components.

Syntax

Copy

bool RtfwSetMonitorComponents(
    [in]   RT_MONITOR_COMPONENT componentsToEnable
);

Parameters

[out] componentsEnabled

A pointer to an RT_MONITOR_COMPONENT enumeration that specifies wRTOS product components that can have their monitoring event generation enabled/disabled persistently or transiently.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE, sets the last error value, and leaves the structure pointed to with invalid data. Call GetLastError to obtain an error code.

Remarks

The following is the best practice for using Native Library Get/Set APIs that take structures as arguments:

Call the Get function.
Modify the value(s) you want to change.
Call the corresponding Set function.

The values passed in by the Set function will be saved (persistent).

Any pathname passed to this function must not refer to a network location. This includes:

A pathname with a drive letter that specifies a mapped file share.
A UNC path: a pathname that starts with \\servername.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtfwApi.h	RtfwApi.lib