Share via


IMsRdpClient

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This interface is the default interface to the Remote Desktop ActiveX control. This interface provides the methods and properties needed to configure and use the ActiveX client control. It also provides methods to access the IMsRdpClientAdvancedSettings and IMsRdpClientSecuredSettings interfaces. The IMsRdpClient interface was added for RDP clients (version 5.1 and later).

IMsRdpClient is a dual interface.

IMsRdpClient derives from the IMsTscAx interface. It inherits all the IMsTscAx methods, and provides additional methods.

Methods

The IMsRdpClient interface provides the following methods.

The following table shows the methods on the IMsRdpClient interface.

Method Description

get_AdvancedSettings2

Retrieves a pointer to IMsRdpClientAdvancedSettings interface. The interface can be used to set advanced settings for the ActiveX client control.

get_ColorDepth

Retrieves the value of the ColorDepth property that is currently set for the ActiveX client control.

get_ExtendedDisconnectReason

Retrieves extended information about the ActiveX client control's reason for disconnection.

get_SecuredSettings2

Retrieves a pointer to IMsRdpClientSecuredSettings interface. The interface can be used to set secured settings for the ActiveX client control.

GetVirtualChannelOptions

Retrieves the options set for a virtual channel.

put_ColorDepth

Sets the value of the ColorDepth property, which specifies the color depth for the ActiveX client control.

RequestClose

Requests a graceful shutdown of the ActiveX client control.

SetVirtualChannelOptions

Sets virtual channel options for the ActiveX client control.

Requirements

Header discodlg.h, mstsax.idl
Library Mstsax.lib
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Reference

IMsRdpClient Properties

Concepts

Remote Desktop ActiveX Control Interfaces