RemoteDesktopConnectionInfo Class

  • Reference

Definition

Namespace:
Windows.System.RemoteDesktop.Provider
Edit

Represents a remote desktop connection on the local desktop.

Important

The RemoteDesktopConnectionInfo API is part of a Limited Access Feature (see LimitedAccessFeatures class). For more information or to request an unlock token, please use the LAF Access Token Request Form.

public ref class RemoteDesktopConnectionInfo sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 983040)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class RemoteDesktopConnectionInfo final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 983040)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class RemoteDesktopConnectionInfo
Public NotInheritable Class RemoteDesktopConnectionInfo
Inheritance
Object Platform::Object IInspectable RemoteDesktopConnectionInfo
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 11 Insider Preview (introduced in 10.0.23504.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v15.0)

Remarks

Get an instance of this class by calling GetForLaunchUri.

For the remote desktop connections to CloudPCs that are launched from Task view, users can configure which redirections they allow in the Settings app under the Privacy and security > CloudPC tab. Applications using this API may want to read the following registry keys to honor the Cloud PC configuration set by the user in the Settings application:

Feature Registry Key
Clipboard HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\CloudPCSetting\AllowClipboardRedirection
Printer HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\CloudPCSetting\AllowPrinterRedirection
Local Hard Drive HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\CloudPCSetting\AllowLocalHardDriveRedirection
Microphone HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\CloudPCSetting\AllowMicrophoneRedirection
Location HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\CloudPCSetting\AllowLocationRedirection
Camera HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\CloudPCSetting\AllowCameraRedirection
Smart Card HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\CloudPCSetting\AllowSmartCardRedirection
USB ports HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\CloudPCSetting\AllowUSBPortsRedirection
COM ports HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\CloudPCSetting\AllowCOMPortsRedirection

The value for each key is a REG_DWORD and is interpreted using the following semantics:

  • Off value: 0
  • On value: 1
  • No value (default): 1

Methods

GetForLaunchUri(Uri, WindowId)

Retrieves a RemoteDesktopConnectionInfo associated with a remote desktop connection and registers a window with the OS to represent the remote desktop.
PerformLocalActionFromRemote(RemoteDesktopLocalAction)
SetConnectionStatus(RemoteDesktopConnectionStatus)

Sets the connection status for the remote desktop connection associated with the RemoteDesktopConnectionInfo.
SwitchToLocalSession()

Notifies the OS that the user has requested to switch to the local session.

Applies to