RtfwGetConsoleConfiguration

RtfwGetConsoleConfiguration retrieves the configuration of real-time application output consoles.

Syntax

Copy

bool RtfwGetConsoleConfiguration(
    [out]   RTFW_CONSOLE_CONFIGURATION * pConfig
);

Parameters

[out] pConfig

Points to structure RTFW_CONSOLE_CONFIGURATION that will be filled in with the console settings. This pointer cannot be NULL and 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, sets the last error value, and leaves the memory pointed to by pConfig undefined. Call GetLastError to obtain an error code.

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

Possible Error codes

Error code	Meaning
ERROR_INVALID_PARAMETER	Pointer pConfig is NULL.
RT_ERROR_STRUCTURE_TOO_SMALL	This error occurs when member Size in the structure passed to the get/set APIs is not set to sizeof(RTFW_CONSOLE_CONFIGURATION).

Remarks

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

Requirements

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