RtfwrlySetVerbosity

RtfwrlySetVerbosity enables or disables verbosity for the Network Relay component.

Syntax

Copy
bool RtfwrlySetVerbosity(
    [in] bool enabled,
);

Parameters

[in] enabled

A value of TRUE enables verbosity for the Network Relay component. A value of FALSE disables verbosity.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE.

Remarks

When verbosity is disabled, warning and error messages will be logged to the Event Viewer and provided through toast messages. When verbosity is enabled, additional informational messages will be written to the wRTOS Console.

If the Network Relay component is running when RtfwrlySetVerbosity is called, the function will return TRUE and set the last error to RTRLY_ERROR_RESTART_NEEDED.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtfwrlyApi.h

RtfwrlyApi.lib

See Also: