IMsRdpClient::SetVirtualChannelOptions method

Article
12/11/2020

Sets the virtual channel options for the Remote Desktop ActiveX control.

Call this method after calling the CreateVirtualChannels method, but before establishing a connection with the Connect method. This method sets additional options on virtual channels that have been created with CreateVirtualChannels.

Syntax

HRESULT SetVirtualChannelOptions(
  [in] BSTR ChanName,
  [in] LONG chanOptions
);

Parameters

ChanName [in]: The name of the virtual channel that was specified in the call to the CreateVirtualChannels method.
chanOptions [in]: The options to set for the virtual channel specified by the ChanName parameter. For a description of possible options, see CHANNEL_DEF. For more information, see the following Remarks section.

Return value

Return S_OK if successful.

Remarks

An example of using this method would be to declare the channel as remote control persistent by setting the CHANNEL_OPTION_REMOTE_CONTROL_PERSISTENT flag. This means that the channel would not be closed when a remote control connects to or disconnects from the session connected to the client. For more information, see Remote Control Persistent Virtual Channels.

For more information about Remote Desktop Web Connection, see Requirements for Remote Desktop Web Connection.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Type library	MsTscAx.dll
DLL	MsTscAx.dll
IID	IID_IMsRdpClient is defined as 92b4a539-7115-4b7c-a5a9-e5d9efc2780a