ExternalSessionConfiguration
Configuration for launching an external Remote Desktop client process. Support: external sessions only.
Type
RoyalApps.Community.Rdp.WinForms.Configuration.External.ExternalSessionConfigurationUsed By
Properties
AdditionalArguments (string?)
Gets or sets additional command-line arguments appended after the generated .rdp file path.
AdditionalMsRdpExSettings (Collection<RdpFileSetting>)
Gets additional MsRdpEx-specific RDP settings that are appended after the built-in mapping when ExternalSessionConfiguration.UseMsRdpExHooks is enabled.
AdditionalRdpSettings (Collection<RdpFileSetting>)
Gets additional standard RDP settings that are appended after the built-in mapping.
CloseTimeout (TimeSpan)
Gets or sets the amount of time to wait for a graceful shutdown after requesting the external process to close.
CredentialTarget (string?)
Gets or sets the credential target name. When not set, a TERMSRV/... target is derived from the configured server and port.
KeepTemporaryRdpFile (bool)
Gets or sets a value indicating whether the generated .rdp file should be kept after the session ends.
KillProcessOnDisconnect (bool)
Gets or sets a value indicating whether System.Diagnostics.Process.Kill(System.Boolean) should be used if graceful shutdown does not finish within ExternalSessionConfiguration.CloseTimeout.
KillProcessOnHostExit (bool)
Gets or sets a value indicating whether the external process should be assigned to a Windows job so it is terminated when the host process exits unexpectedly.
MsRdpExLauncherPath (string?)
Gets or sets the full path to mstscex.exe. When not set, well-known installation folders are probed.
MsRdpExSearchPaths (Collection<string>)
Gets additional directories or full file paths that should be probed for mstscex.exe before the built-in well-known installation folders. Support: external sessions through MsRdpEx only. This is intended for app-local deployment scenarios where the MsRdpEx release files are shipped next to the host application.
MstscPath (string?)
Gets or sets the full path to mstsc.exe. When not set, the system default is used.
SelectedMonitors (string?)
Gets or sets the comma-separated monitor identifiers written to the selectedmonitors RDP property. This setting is only applied in external mode and requires multi-monitor mode. Monitor identifiers can be discovered with mstsc.exe /l. Embedded mode rejects this value instead of trying to approximate the monitor layout.
TemporaryDirectory (string?)
Gets or sets the directory used for the temporary .rdp file. When not set, the system temp directory is used.
UseCredentialManager (bool)
Gets or sets a value indicating whether a credential should be materialized in the Windows credential manager before launch.
UseMsRdpExHooks (bool)
Gets or sets a value indicating whether the external connection should be launched through mstscex.exe when it is available.