RtfwSetMonitorConfiguration

RtfwSetMonitorConfiguration sets the wRTOS Subsystem’s default Monitoring configuration.

Syntax

Copy

bool RtfwSetMonitorConfiguration(
    [in]    const RTFW_MONITOR_CONFIGURATION * pMonitorConfiguration
);

Parameters

[in] pMonitorConfiguration

A pointer to an RTFW_MONITOR_CONFIGURATION structure that specifies the new Monitoring Framework configuration parameters. The member Size must be set to sizeof(RTFW_MONITOR_CONFIGURATION), otherwise this API fails and sets the last error value to RT_ERROR_STRUCTURE_TOO_SMALL.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

Possible error codes:

Error code	Meaning
RT_ERROR_RESTART_SUBSYSTEM	The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the Subsystem must be restarted. Note: The wRTOS Subsystem must be restarted for the change to take effect.
RT_ERROR_STRUCTURE_TOO_SMALL	The member Size of a structure is too small.

Error code

Meaning

RT_ERROR_RESTART_SUBSYSTEM

The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the Subsystem must be restarted.

Note: The wRTOS Subsystem must be restarted for the change to take effect.

RT_ERROR_STRUCTURE_TOO_SMALL

The member Size of a structure is too small.

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