IntervalZero RTX64 Managed Code Framework

ServerConsole Class

This class reads and modifies the configuration of the RTX64 Server Console. Assignments to properties on an instance of this class modify Registry values that contain the persistent state of the configuration of the Server Console. After changing the configuration of the Server Console using this class, the Server Console must be restarted for those changes to take effect.

Inheritance Hierarchy

SystemObject
IntervalZero.RTX64RTX64Object
IntervalZero.RTX64.ConfigServerConsole

Namespace: IntervalZero.RTX64.Config
Assembly: IntervalZero.RTX64 (in IntervalZero.RTX64.dll) Version: 3.3.0.0 (File version: 3.5.0)

Syntax

C++

Copy

public class ServerConsole : RTX64Object, 
	IConfigServerConsole

Public Class ServerConsole
	Inherits RTX64Object
	Implements IConfigServerConsole

public ref class ServerConsole : public RTX64Object, 
	IConfigServerConsole

type ServerConsole =  
    class
        inherit RTX64Object
        interface IConfigServerConsole
    end

The ServerConsole type exposes the following members.

Constructors

	Name	Description
	ServerConsole	Constructor.

Top

Properties

	Name	Description
	AutoClose	Gets/sets whether real-time application consoles close automatically. If true, the consoles close automatically, otherwise they remain open until the user closes them. When configured to close automatically, and if property UsePerProcessConsoles is true, each console closes when its corresponding real-time process terminates. When UsePerProcessConsoles is false, the single console closes when the Subsystem stops.
	CreationTime	Date and time the object was created. (Inherited from RTX64Object.)
	DisplayBufferSize	Gets or sets the screen buffer size (in kilobytes) of real-time application consoles. If console output exceeds this limit, the oldest text in the console window is deleted.
	DisplayUserInterface	This property controls whether real-time application console display program output. If set to true, program output is displayed, otherwise it is not displayed. Logging of program output is configured independently from this configuration setting (see property LogDataToFile).
	IsDisposed	True if the object has been disposed, false otherwise. (Inherited from RTX64Object.)
	LogDataToFile	This property controls whether real-time application consoles log program output to a log file. If this property is set to true, program output is logged to the file configured by property LogFileName.
	LogFileName	This property configures the pathname of the file to which program output is logged when property LogDataToFile is set to true. If this property's value is the empty string, no logging happens (even if property LogDataToFile is true. If an error occurs reading the persisent state of this property from the Registry, program output is logged either to a file named "Rtx64ServerLog.txt" on the current user's desktop or the file "C:\Rtx64ServerLog.txt". NOTE: This property is deprecated and will be removed from a future release.
	LogFolder	This property gets/sets the pathname of the folder where real-time application console log files are written. If this pathname doesn't exist, an exception is thrown.
	LogFolderMaxDiskSize	This property gets/sets the maximum size of the real-time application console log folder, in megabytes. The minimum valid value is 1 MB. The maximum valid value is uint.MaxValue MB.
	Name	Name of the object. (Inherited from RTX64Object.)
	StartMinimized	If this property is true, real-time application consoles start minimized, otherwise it doesn't.
	SuppressWarnings	If this property is true, real-time application consoles suppress all warning dialogs, otherwise warning dialogs are not suppressed. NOTE: This property is deprecated and will be removed from a future release.
	TCPPort	This property gets/sets the TCP port number on which RtxServer listens for real-time application console connections. The minimum valid valid is 1. The maximum valid value is 65535.
	UsePerProcessConsoles	This property gets/sets whether or not each real-time process displays output in its own real-time application console. If true, per-process consoles are used, otherwise only one console shows output from all real-time processes.

Top

Methods

	Name	Description
	Dispose	Dispose method. (Inherited from RTX64Object.)
	OnNotifyPropertyChanged	Called when a property is changed (Inherited from RTX64Object.)
	Reset	Resets all ServerConsole properties to thier default values
	ResetAutoClose	Resets property AutoClose to its default value.
	ResetDisplayBufferSize	Resets property DisplayBufferSize to its default value (64).
	ResetDisplayUserInterface	Resets property DisplayUserInterface to its default value (true).
	ResetLogDataToFile	Resets property LogDataToFile to its default value (false).
	ResetLogFileName	Resets property LogFileName to its default value (Desktop Folder\ServerLog.txt). NOTE: This method is deprecated and will be removed from a future release.
	ResetLogFolder	Resets property LogFolder to its default value.
	ResetLogFolderMaxDiskSize	Resets property LogFolderDiskSize to its default value.
	ResetStartMinimized	Resets property StartMinimized to its default value (false).
	ResetSuppressWarnings	Resets property SuppressWarnings to its default value (false). NOTE: This method is deprecated and will be removed from a future release.
	ResetTCPPort	Resets property TCPPort to its default value.
	ResetUsePerProcessConsoles	Resets property UsePerProcessConsoles to its default value.

Top

Events

	Name	Description
	PropertyChanged	Event Fired when a property value is changed (Inherited from RTX64Object.)

Top

Reference

IntervalZero.RTX64.Config Namespace