RtfwGetConsoleConfiguration

RtfwGetConsoleConfiguration retrieves the configuration of the RTX64 real-time output console.

NOTE: This function is deprecated and will be removed from a future release. It will fail in RTX64 4.1 and later versions. Use RtfwGetConsoleConfigurationEx.

Syntax

bool RtfwGetConsoleConfiguration(
    RTFW_CONSOLE_CONFIGURATION * pConsoleConfiguration
);

Parameters

pConsoleConfiguration

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

The function returns true if it succeeds. Otherwise, it returns false, sets the last error value, and leaves the memory pointed to by pConsoleConfiguration undefined. Call GetLastError for additional error information.

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

See Also:

RtfwSetConsoleConfiguration

RTFW_CONSOLE_CONFIGURATION