RtfwSetConsoleConfiguration

RtfwGetConsoleConfiguration configures real-time application output consoles.

Syntax

Copy

bool RtfwSetConsoleConfiguration(
    [in]    RTFW_CONSOLE_CONFIGURATION * pConfig
);

Parameters

[in] pConsoleConfiguration

Points to a RTFW_CONSOLE_CONFIGURATION structure that specifies the new configuration parameters of the real-time output console. This value cannot be NULL and the member Size must be set by the caller to the value sizeof(RTFW_CONSOLE_CONFIGURATION).

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE and sets the last error value based on the cause of the failure. Call GetLastError to obtain an error code.

Possible error codes:

Error code	Meaning
ERROR_BAD_PATHNAME	This error indicates an issue with the log file.
ERROR_INVALID_PARAMETER	This error indicates one or more of the following scenarios: Pointer pConfig is NULL. Field Size is too small. Field DisplayBufferSize is 0. The way to not see output is to set field DisplayConsole to FALSE. Field LogFolderDiskSize is less than 1. Field LogFolder pathname does not exist. Field TCPPort is 0.
RT_ERROR_CONSOLE_CONFIG_TCPPORT_INVALID	The TCPPort value is invalid.
RT_ERROR_CONSOLE_CONFIG_DISPLAYBUFFERSIZE_INVALID	The DisplayBufferSize value is invalid.
RT_ERROR_CONSOLE_CONFIG_LOGFOLDERMAXSIZE_INVALID	The LogFolderDiskSize value is invalid.
RT_ERROR_RESTART_SUBSYSTEM	The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the wRTOS Subsystem must be restarted. Note: The wRTOS Subsystem must be restarted for the change to take effect.

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).

Requirements

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