IMsTscAx interface

Enables you to connect and disconnect the client control, create virtual channel objects, and send data over a virtual channel. The interface also contains methods to retrieve and set properties related to the client control. These methods are also available through the IMsRdpClient interface.

Members

The IMsTscAx interface inherits from the IDispatch interface. IMsTscAx also has these types of members:

Methods

The IMsTscAx interface has these methods.

MethodDescription
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.

SendOnVirtualChannel

Sends data to the RD Session Host server over a virtual channel that was created previously by using the IMsTscAx::CreateVirtualChannels method.

 

Properties

The IMsTscAx interface has these properties.

PropertyAccess typeDescription

AdvancedSettings

Read-only

An IMsTscAdvancedSettings interface pointer.

CipherStrength

Read-only

The maximum encryption strength of the current control.

Connected

Read-only

The connection state of the current control.

ConnectingText

Read/write

The text that appears centered in the control while the control is connecting.

DesktopHeight

Read/write

The current control's height, in pixels, on the initial remote desktop.

DesktopWidth

Read/write

The current control's width, in pixels, on the initial remote desktop.

DisconnectedText

Read/write

The text that appears centered in the control before a connection is terminated.

Domain

Read/write

The domain to which the current user logs on.

FullScreenTitle

Write-only

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.

SecuredSettings

Read-only

A IMsTscSecuredSettings interface pointer.

SecuredSettingsEnabled

Read-only

Indicates whether the IMsTscSecuredSettings interface is available.

Server

Read/write

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.

UserName

Read/write

The user name logon credential.

Version

Read-only

The version number of the current control.

VerticalScrollBarVisible

Read-only

Indicates whether the control displays a vertical scroll bar.

 

Remarks

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

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Type library

MsTscAx.dll

DLL

MsTscAx.dll

CLSID

CLSID_MsRdpClient is defined as 791fa017-2de3-492e-acc5-53c67a2b94d0

CLSID_MsRdpClient10 is defined as C0EFA91A-EEB7-41C7-97FA-F0ED645EFB24

CLSID_MsRdpClient10NotSafeForScripting is defined as A0C63C30-F08D-4AB4-907C-34905D770C7D

CLSID_MsRdpClient2 is defined as 9059F30F-4EB1-4BD2-9FDC-36F43A218F4A

CLSID_MsRdpClient2a is defined as 971127BB-259F-48C2-BD75-5F97A3331551

CLSID_MsRdpClient2NotSafeForScripting is defined as 3523C2FB-4031-44E4-9A3B-F1E94986EE7F

CLSID_MsRdpClient3 is defined as 7584C670-2274-4EFB-B00B-D6AABA6D3850

CLSID_MsRdpClient3a is defined as 6A6F4B83-45C5-4CA9-BDD9-0D81C12295E4

CLSID_MsRdpClient3NotSafeForScripting is defined as ACE575FD-1FCF-4074-9401-EBAB990FA9DE

CLSID_MsRdpClient4 is defined as 4EDCB26C-D24C-4E72-AF07-B576699AC0DE

CLSID_MsRdpClient4a is defined as 54CE37E0-9834-41AE-9896-4DAB69DC022B

CLSID_MsRdpClient4NotSafeForScripting is defined as 6AE29350-321B-42BE-BBE5-12FB5270C0DE

CLSID_MsRdpClient5 is defined as 4EB89FF4-7F78-4A0F-8B8D-2BF02E94E4B2

CLSID_MsRdpClient5NotSafeForScripting is defined as 4EB2F086-C818-447E-B32C-C51CE2B30D31

CLSID_MsRdpClient6 is defined as 7390F3D8-0439-4C05-91E3-CF5CB290C3D0

CLSID_MsRdpClient6NotSafeForScripting is defined as D2EA46A7-C2BF-426B-AF24-E19C44456399

CLSID_MsRdpClient7 is defined as A9D7038D-B5ED-472E-9C47-94BEA90A5910

CLSID_MsRdpClient7NotSafeForScripting is defined as 54D38BF7-B1EF-4479-9674-1BD6EA465258

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

CLSID_MsRdpClientNotSafeForScripting is defined as 7CACBD7B-0D99-468F-AC33-22E495C0AFE5

CLSID_MsTscAx is defined as 1FB464C8-09BB-4017-A2F5-EB742F04392F

CLSID_MsTscAxNotSafeForScripting is defined as A41A4187-5A86-4E26-B40A-856F9035D9CB

IID

IID_IMsTscAx is defined as 8C11EFAE-92C3-11D1-BC1E-00C04FA31489

See also

IDispatch
Remote Desktop Web Connection Reference

 

 

Show: