RtfwSetConsoleConfiguration
RtfwGetConsoleConfiguration configures the RTX64 real-time output console.
Syntax
bool RtfwSetConsoleConfiguration( RTFW_CONSOLE_CONFIGURATION * pConsoleConfiguration );
Parameters
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
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_INVALID_PARAMETER | The LogPathName directory does not exist. |
| 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).
RtfwSetConsoleConfiguration crashes when it passes a path with length MAX_PATH (260 characters). This causes an unhandled exception: An invalid parameter was passed to a function that considers invalid parameters fatal.
Requirements
| Minimum Required Version | RTX64 3.4 |
| Header | RtfwAPI.h |
| Library | RtfwAPI.lib |
See Also:
