Skip to content

RdpClientConfiguration ​

The remote desktop client configuration.

Type ​

csharp
RoyalApps.Community.Rdp.WinForms.Configuration.RdpClientConfiguration

Used By ​

Properties ​

ClientVersion (int) ​

The client version to use. By default (value is 0) the highest available client will be used.

LogEnabled (bool) ​

When true, process-wide MsRdpEx logging is enabled and written to RdpClientConfiguration.LogFilePath. All controls in a process should use the same logging configuration.

LogFilePath (string) ​

Gets or sets the process-wide MsRdpEx log file path used when RdpClientConfiguration.LogEnabled is enabled.

LogLevel (string) ​

Gets or sets the process-wide MsRdpEx log level, for example TRACE, DEBUG, INFO, WARN, ERROR, or FATAL.

MsRdcPath (string?) ​

Gets or sets the directory that is probed first for Microsoft Remote Desktop Client files such as rdclientax.dll.

PluginDlls (string?) ↗ ​

Specifies the names of virtual channel client DLLs to be loaded. Virtual channel client DLLs are also referred to as Plug-in DLLs. Comma-separated list of the names of the virtual channel client DLLs to be loaded. The DLL names must contain only alphanumeric characters.

Port (int) ↗ ​

Specifies the connection port. The default value is 3389.

Server (string?) ↗ ​

Specifies the name of the server to which the current control is connected. The new server name. This parameter can be a DNS name or IP address. This property must be set before calling the Connect method. It is the only property that must be set before connecting.

SessionMode (RdpSessionMode) ​

Selects whether the connection should be hosted inside the control or by an external client process.

UseMsRdc (bool) ​

When true, the Microsoft Remote Desktop Client is used when available instead of the legacy MSTSC ActiveX control.

Back to API index

MIT Licensed