RTFW_CONSOLE_CONFIGURATION Structure

RTFW_CONSOLE_CONFIGURATION represents the configuration of the RTX64 real-time output console.

NOTE: This structure is deprecated and will be removed from a future release. Use RTFW_CONSOLE_CONFIGURATION_EX.

Syntax

typedef struct _RTFW_CONSOLE_CONFIGURATION(
    size_t Size;
    bool DisplayConsole;
    unsigned int DisplayBufferSize;
    bool LogOutputToFile;
    bool StartMinimized;
    bool SuppressWarnings;
    TCHAR LogPathName[MAX_PATH];
} RTFW_CONSOLE_CONFIGURATION, * PRTFW_CONSOLE_CONFIGURATION;

Members

Size

The size of this structure (in bytes). Client code must set this member to sizeof(RTFW_CONSOLE_CONFIGURATION) before passing this structure to any function. This is used to identify the version of this structure if it is extended.

DisplayBufferSize

The upper limit (in kilobytes) of textual data that will be displayed in the RTX64 Server Console window (the window where output from real-time processes is displayed). When this limit is exceeded, the oldest characters in the window are removed, leaving only the most recent DisplayBufferSize kilobytes of character data. If this value is 0, there is no limit on how much textual data will be displayed.

NOTE: While there is no upper limit on this value, setting it to very large values can cause the RTX64 Server Console application to consume excessive amounts of virtual memory.

DisplayConsole

If true, the output from a real-time application will cause a real-time output console to appear. If false, a console will not appear.

LogOutputToFile

If true, output from real-time processes are written to a common log file. If false, output is not written to the log file.

StartMinimized

If displaying the console, and this is true, the console window starts in a minimized state. If false, the console window will be visible. If not displaying the console this has no affect.

SuppressWarnings

If true, the output console will not ask the user if they wish to save the content of the console to a log file on close. If false, the user will be asked if they wish to save the output on close.

LogPathName

The absolute pathname of the log file where output from real-time applications is appended if member LogOutputToFile is true.

IMPORTANT! This file is never removed and never truncated, so its size can grow without bound. If this file does not exist, it is created. User SYSTEM must have permission to create and write this file, otherwise output will not be written to this file.

See Also:

RtfwGetConsoleConfiguration

RtfwSetConsoleConfiguration