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 XP

Minimum supported server

Windows Server 2003

Type library

Mstscax.dll

DLL

Mstscax.dll

IID

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

See also

Remote Desktop Web Connection Reference

 

 

Show:
© 2014 Microsoft. All rights reserved.