IMsRdpClient8 interface

Article
12/11/2020

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

Members

The IMsRdpClient8 interface inherits from IMsRdpClient7. IMsRdpClient8 also has these types of members:

Methods
Properties

Methods

The IMsRdpClient8 interface has these methods.

Method	Description
Connect	Initiates a connection using the properties currently set on the control.
CreateVirtualChannels	Creates a client-side virtual channel object for each specified virtual channel name.
Disconnect	Disconnects the active connection.
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.
SendOnVirtualChannel	Sends data to the RD Session Host server over a virtual channel that was created previously by using the CreateVirtualChannels method.
SendRemoteAction	Causes an action to be performed in the remote session.
SetVirtualChannelOptions	Sets the virtual channel options for the Remote Desktop ActiveX control.

Properties

The IMsRdpClient8 interface has these properties.

Property	Access type	Description
AdvancedSettings	Read-only	Retrieves an IMsTscAdvancedSettings interface pointer.
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.
CipherStrength	Read-only	Retrieves the maximum encryption strength of the current control.
ColorDepth	Read/write	The color depth (in bits per pixel) for the control's connection.
Connected	Read-only	Retrieves the connection state of the current control.
ConnectedStatusText	Read/write	Contains the text that is displayed in the client area of the control while the control is in the connected state.
ConnectingText	Read/write	Specifies the text that appears centered in the control while the control is connecting.
DesktopHeight	Read/write	Specifies the current control's height, in pixels, on the initial remote desktop.
DesktopWidth	Read/write	Specifies the current control's width, in pixels, on the initial remote desktop.
DisconnectedText	Read/write	Specifies the text that appears centered in the control before a connection is terminated.
Domain	Read/write	Specifies the domain to which the current user logs on.
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.
FullScreenTitle	Write-only	Specifies the window title displayed when the control is in full-screen mode.
HorizontalScrollBarVisible	Read-only	Indicates whether the control has displayed a horizontal scroll bar.
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.
SecuredSettings	Read-only	Retrieves an IMsTscSecuredSettings interface pointer.
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.
SecuredSettingsEnabled	Read-only	Indicates whether the IMsTscSecuredSettings interface is available. That is, whether the webpage containing the control is currently in one of the allowed Internet Explorer URL security zones.
Server	Read/write	Specifies the name of the server to which the current control is connected.
StartConnected	Read/write	Indicates whether the control will establish the RD Session Host server connection immediately upon startup.
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.
UserName	Read/write	Specifies the user name logon credential.
Version	Read-only	Specifies the version number of the current control.
VerticalScrollBarVisible	Read-only	Indicates whether the control displays a vertical scroll bar.

Remarks

The IMsRdpClient8 interface has been extended by the following interfaces, with each new interface inheriting all the methods and properties of the previous interfaces:

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

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
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 CLSID_MsRdpClient8 is defined as 5F681803-2900-4C43-A1CC-CF405404A676 CLSID_MsRdpClient8NotSafeForScripting is defined as A3BC03A0-041D-42E3-AD22-882B7865C9C5 CLSID_MsRdpClient9 is defined as 301B94BA-5D25-4A12-BFFE-3B6E7A616585 CLSID_MsRdpClient9NotSafeForScripting is defined as 8B918B82-7985-4C24-89DF-C33AD2BBFBCD
IID	IID_IMsRdpClient8 is defined as 4247E044-9271-43A9-BC49-E2AD9E855D62