RemoteDesktopConnectionInfo.GetForLaunchUri(Uri, WindowId) Method

Reference

Definition

Namespace:: Windows.System.RemoteDesktop.Provider

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Retrieves a RemoteDesktopConnectionInfo associated with a remote desktop connection and registers a window with the OS to represent the remote desktop.

public:
 static RemoteDesktopConnectionInfo ^ GetForLaunchUri(Uri ^ launchUri, WindowId windowId);

 static RemoteDesktopConnectionInfo GetForLaunchUri(Uri const& launchUri, WindowId const& windowId);

public static RemoteDesktopConnectionInfo GetForLaunchUri(System.Uri launchUri, WindowId windowId);

function getForLaunchUri(launchUri, windowId)

Public Shared Function GetForLaunchUri (launchUri As Uri, windowId As WindowId) As RemoteDesktopConnectionInfo

Parameters

launchUri: Uri Uri

The launch URI used by the shell to launch the remote desktop client app, with information about the remote desktop session.

windowId: WindowId

The WindowId of the window that will represent the remote desktop.

Returns

RemoteDesktopConnectionInfo

A RemoteDesktopConnectionInfo associated with the remote desktop connection.

Remarks

This call is made by the remote desktop client app running on the local desktop.

The provider app completes the launch handshake by passing the launch protocol string to GetForLaunchUri.

Launch URIs

The launchUri is used to launch the remote desktop client app. Example URI format:

ms-remotedesktop:switch?remoteDesktopId={remote desktop Id}&correlationId={correlation Id}&supportBluetoothSettings=false

Remote desktop client apps must register to handle the ms-remotedesktop-launch URI scheme to enable launching Windows 365 Cloud PCs using Windows 365 Switch. Example URI format:

ms-remotedesktop-launch:?supportBluetoothSettings={true if local PC supports Bluetooth settings page}&correlationId={correlation Id}

Remote desktop client apps must register to handle the ms-remotedesktop-launch Uri scheme if they want to launch Windows 365 Cloud PCs using Windows 365 Boot.

Applies to

Share via