IMsRdpClientNonScriptable8::StartWorkspaceExtension method

Article
09/26/2023

Coordinates the client's remote session with the RemoteApp and Desktop Connections control panel.

Note

The RemoteApp and Desktop Connections control panel is no longer in active development. It may be altered or unavailable in future versions of Windows. The use of this API is discouraged.

Syntax

HRESULT StartWorkspaceExtension( 
    [in] VARIANT_BOOL isWebHosted,
    [in] BSTR workspaceId,
    [in] BYTE *publisherThumbPrint,
    [in] UINT publisherThumbPrintLength
);

Parameters

isWebHosted

A value indicating whether the connection is hosted from a website.

workspaceId

A string that contains the ID of a connection in the RemoteApp and Desktop Connections control panel.

publisherThumbPrint

An array of bytes representing the thumbprint in binary format to pass to IWorkspaceScriptable3::StartWorkspaceEx2 as bstrWorkspaceParams. See Remarks.

publisherThumbPrintLength

The number of bytes pointed to by publisherThumbPrint.

Return value

Return S_OK if successful.

Remarks

This function handles the following scenarios:

Upon connection with the remote session:
- After prompting the user for credentials, it associates them with a connection in the RemoteApp and Desktop Connections control panel via IWorkspaceScriptable3::StartWorkspaceEx2
- It notifies the RemoteApp and Desktop Connections control panel of the existence of the remote session via IWorkspaceRegistration2::AddResourceEx.
Upon disconnection from the remote session:
- It alerts the user that the remote session has been dismissed via IWorkspaceScriptable2::ResourceDismissed
- It notifies the RemoteApp and Desktop Connections control panel of the disconnection via IWorkspaceRegistration2::RemoveResourceEx.

Requirements

Requirement	Value
Minimum supported client	Windows 11 Version 23H2
Type library	MsTscAx.dll
DLL	MsTscAx.dll
IID	IID_IMsRdpClientNonScriptable8 is defined as B2B3FA47-3F11-4148-AD24-DFF8684A16D0

Share via