RtfwGetConsoleConfigurationEx

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

Syntax

bool RtfwGetConsoleConfigurationEx(
    RTFW_CONSOLE_CONFIGURATION_EX * pConfig
);

Parameters

pConfig

Points to structure RTFW_CONSOLE_CONFIGURATION_EX 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_EX).

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 pConfig undefined. Call GetLastError for additional error information.

If the Subsystem is running when the RtfwSetConsoleConfigurationEx 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_EX).

See Also:

RtfwSetConsoleConfigurationEx

RTFW_CONSOLE_CONFIGURATION_EX