IMsRdpClient10 interface

Article
12/11/2020

Provides the methods and properties needed to configure and use the client control. Derives from the IMsRdpClient9 interface.

Members

The IMsRdpClient10 interface inherits from IMsRdpClient9. IMsRdpClient10 also has these types of members:

Methods
Properties

Methods

The IMsRdpClient10 interface has these methods.

Method	Description
attachEvent	Attaches an event.
detachEvent	Detaches an event.
GetErrorDescription	Retrieves the error description for the session disconnect events.
GetStatusText	Retrieves the status text for the specified status code.
GetVirtualChannelOptions	Retrieves the options set for a virtual channel.
Reconnect	Reconnects to the remote session with the new desktop width and height.
RequestClose	Requests a graceful shutdown of the Remote Desktop ActiveX control.
SendRemoteAction	Causes an action to be performed in the remote session.
SetVirtualChannelOptions	Sets the virtual channel options for the Remote Desktop ActiveX control.
SyncSessionDisplaySettings	Synchronizes session display settings.
UpdateSessionDisplaySettings	Updates session display settings.

Properties

The IMsRdpClient10 interface has these properties.

Property	Access type	Description
AdvancedSettings2	Read-only	Retrieves a pointer to the IMsRdpClientAdvancedSettings interface. The interface can be used to set advanced settings for the client control.
AdvancedSettings3	Read-only	Retrieves a pointer to the IMsRdpClientAdvancedSettings2 interface. The interface can be used to set advanced settings for the client control.
AdvancedSettings4	Read-only	Retrieves a pointer to the IMsRdpClientAdvancedSettings3 interface.
AdvancedSettings5	Read-only	Retrieves a pointer to an IMsRdpClientAdvancedSettings4 interface.
AdvancedSettings6	Read-only	Retrieves the IMsRdpClientAdvancedSettings5 interface.
AdvancedSettings7	Read-only	Retrieves the IMsRdpClientAdvancedSettings6 interface.
AdvancedSettings8	Read-only	Retrieves an object that supports the IMsRdpClientAdvancedSettings7 interface.
AdvancedSettings9	Read-only	Contains an object that supports the IMsRdpClientAdvancedSettings8 interface.
ColorDepth	Read/write	The color depth (in bits per pixel) for the control's connection.
ConnectedStatusText	Read/write	Contains the text that is displayed in the client area of the control while the control is in the connected state.
ExtendedDisconnectReason	Read-only	Contains extended information about the control's reason for disconnection.
FullScreen	Read/write	Determines whether the client control is in full-screen mode.
MsRdpClientShell	Read-only	Retrieves the scriptable client setting interface IMsRdpClientShell.
RemoteProgram	Read-only	Retrieves an object that supports the ITSRemoteProgram interface.
RemoteProgram2	Read-only	Retrieves an object that supports the ITSRemoteProgram2 interface.
RemoteProgram3	Read-only	An object that supports the ITSRemoteProgram3 interface.
SecuredSettings2	Read-only	Retrieves a pointer to the IMsRdpClientSecuredSettings interface. This interface can be used to set secured settings for the client control.
SecuredSettings3	Read-only	Retrieves an object that supports the IMsRdpClientSecuredSettings2 interface.
TransportSettings	Read-only	Retrieves what was passed through a script to the IMsRdpClientTransportSettings interface.
TransportSettings2	Read-only	Retrieves the IMsRdpClientTransportSettings2 interface.
TransportSettings3	Read-only	Retrieves an object that supports the IMsRdpClientTransportSettings3 interface.
TransportSettings4	Read-only	Retrieves an object that supports the IMsRdpClientTransportSettings4 interface.

Remarks

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

Requirements

Requirement	Value
Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016
Type library	MsTscAx.dll
DLL	MsTscAx.dll
CLSID	CLSID_MsRdpClient10 is defined as C0EFA91A-EEB7-41C7-97FA-F0ED645EFB24 CLSID_MsRdpClient10NotSafeForScripting is defined as A0C63C30-F08D-4AB4-907C-34905D770C7D
IID	IID_IMsRdpClient10 is defined as 7ED92C39-EB38-4927-A70A-708AC5A59321