RtfwSetConsoleConfigurationEx
RtfwGetConsoleConfigurationEx configures real-time application output consoles.
Syntax
bool RtfwSetConsoleConfigurationEx( RTFW_CONSOLE_CONFIGURATION_EX * pConfig );
Parameters
pConsoleConfiguration
Points to a RTFW_CONSOLE_CONFIGURATION_EX 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_EX).
Return Value
The function returns true if it succeeds. Otherwise, it returns false and sets the last error value based on the cause of the failure. Call GetLastError for additional error information.
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:
|
RT_ERROR_RESTART_SUBSYSTEM |
The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the RTX64 Subsystem must be restarted. NOTE: The RTX64 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 Required Version | RTX64 4.1 |
Header | RtfwAPI.h |
Library | RtfwAPI.lib |
See Also: