IMsRdpClient::SetVirtualChannelOptions (Windows Embedded CE 6.0)

1/6/2010

This method sets the virtual channel options for the Remote Desktop ActiveX control.

Syntax

HRESULT SetVirtualChannelOptions(
  BSTR chanName,
  LONG chanOptions
);

Parameters

• chanName
  [in] The name of the virtual channel specified in the call to the IMsTscAx::CreateVirtualChannels method,

• chanOptions
  [in] The options to set for the virtual channel specified by ChanName. For a description of possible options, see the CHANNEL_DEF structure

Return Value

If the method succeeds, the return value is S_OK.

If it fails, the method returns a nonzero error code.

Remarks

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

RDP Clients (version 5.1 and later) 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.

Requirements

See Also

Reference

IMsRdpClient
IMsRdpClient::GetVirtualChannelOptions