MSTSCLib Interface Definition

General Information

Library: MSTSCLib (Microsoft Terminal Services Control (redist))

File: msrdp.ocx

GUID: {FC7C887E-70BD-4ADB-8BED-8681D74F36D1}

Version: 1.0

Enumerations

This section lists enumerations exposed by MSTSCLib.

Public Enum __MIDL_IMsRdpClient_0001

exDiscReasonNoInfo=0

exDiscReasonAPIInitiatedDisconnect=1

exDiscReasonAPIInitiatedLogoff=2

exDiscReasonServerIdleTimeout=3

exDiscReasonServerLogonTimeout=4

exDiscReasonReplacedByOtherConnection=5

exDiscReasonOutOfMemory=6

exDiscReasonServerDeniedConnection=7

exDiscReasonLicenseInternal=256

exDiscReasonLicenseNoLicenseServer=257

exDiscReasonLicenseNoLicense=258

exDiscReasonLicenseErrClientMsg=259

exDiscReasonLicenseHwidDoesntMatchLicense=260

exDiscReasonLicenseErrClientLicense=261

exDiscReasonLicenseCantFinishProtocol=262

exDiscReasonLicenseClientEndedProtocol=263

exDiscReasonLicenseErrClientEncryption=264

exDiscReasonLicenseCantUpgradeLicense=265

exDiscReasonLicenseNoRemoteConnections=266

exDiscReasonProtocolRangeStart=4096

exDiscReasonProtocolRangeEnd=32767

End Enum

Public Enum __MIDL_IMsRdpClient_0002

controlCloseCanProceed=0

controlCloseWaitForEvents=1

End Enum

Interfaces

This section lists the Classes exposed by MSTSCLib. For each class, the methods and events are listed.

ControlCloseStatus {00000000-0000-0000-0000-000000000000}

Methods

Const controlCloseCanProceed = 0

Const controlCloseWaitForEvents = 1

Events

None

ExtendedDisconnectReasonCode {00000000-0000-0000-0000-000000000000}

Methods

Const exDiscReasonNoInfo = 0

Const exDiscReasonAPIInitiatedDisconnect = 1

Const exDiscReasonAPIInitiatedLogoff = 2

Const exDiscReasonServerIdleTimeout = 3

Const exDiscReasonServerLogonTimeout = 4

Const exDiscReasonReplacedByOtherConnection = 5

Const exDiscReasonOutOfMemory = 6

Const exDiscReasonServerDeniedConnection = 7

Const exDiscReasonLicenseInternal = 256

Const exDiscReasonLicenseNoLicenseServer = 257

Const exDiscReasonLicenseNoLicense = 258

Const exDiscReasonLicenseErrClientMsg = 259

Const exDiscReasonLicenseHwidDoesntMatchLicense = 260

Const exDiscReasonLicenseErrClientLicense = 261

Const exDiscReasonLicenseCantFinishProtocol = 262

Const exDiscReasonLicenseClientEndedProtocol = 263

Const exDiscReasonLicenseErrClientEncryption = 264

Const exDiscReasonLicenseCantUpgradeLicense = 265

Const exDiscReasonLicenseNoRemoteConnections = 266

Const exDiscReasonProtocolRangeStart = 4096

Const exDiscReasonProtocolRangeEnd = 32767

Events

None

IMsRdpClient {92B4A539-7115-4B7C-A5A9-E5D9EFC2780A}

Methods

Property Let Server(RHS As String)

property Server

Property Get Server() As String

property Server

Property Let Domain(RHS As String)

property Domain

Property Get Domain() As String

property Domain

Property Let UserName(RHS As String)

property UserName

Property Get UserName() As String

property UserName

Property Let DisconnectedText(RHS As String)

property DisconnectedText

Property Get DisconnectedText() As String

property DisconnectedText

Property Let ConnectingText(RHS As String)

property ConnectingText

Property Get ConnectingText() As String

property ConnectingText

Property Get Connected() As Integer

property Connected

Property Let DesktopWidth(RHS As Long)

propery Desktop width

Property Get DesktopWidth() As Long

propery Desktop width

Property Let DesktopHeight(RHS As Long)

propery Desktop Height

Property Get DesktopHeight() As Long

propery Desktop Height

Property Let StartConnected(RHS As Long)

propery start connected

Property Get StartConnected() As Long

propery start connected

Property Get HorizontalScrollBarVisible() As Long

propery HorizontalScrollBarVisible

Property Get VerticalScrollBarVisible() As Long

propery VerticalScrollBarVisible

Property Let FullScreenTitle(RHS As String)

propery FullScreenTitle

Property Get CipherStrength() As Long

propery CipherStrength

Property Get Version() As String

propery Version

Property Get SecuredSettingsEnabled() As Long

propery SecuredSettingsEnabled

Property Get SecuredSettings() As IMsTscSecuredSettings

propery get secured settings

Property Get AdvancedSettings() As IMsTscAdvancedSettings

propery get advanced settings

Sub Connect

Method Connect

Sub Disconnect

Method Disconnect

Sub CreateVirtualChannels(ByVal newVal As String)

Method CreateVirtualChannels

Sub SendOnVirtualChannel(ByVal chanName As String, ByVal ChanData As String)

Method SendOnVirtualChannel(chan name, data)

Property Let ColorDepth(RHS As Long)

property ColorDepth

Property Get ColorDepth() As Long

property ColorDepth

Property Get AdvancedSettings2() As IMsRdpClientAdvancedSettings

propery get advanced settings2

Property Get SecuredSettings2() As IMsRdpClientSecuredSettings

propery get secured settings2

Property Get ExtendedDisconnectReason() As __MIDL_IMsRdpClient_0001

property get extended disconnect reason

Property Let FullScreen(RHS As Boolean)

propery full screen

Property Get FullScreen() As Boolean

propery full screen

Sub SetVirtualChannelOptions(ByVal chanName As String, ByVal chanOptions As Long)

Method SetVirtualChannelOptions(chan name, options)

Function GetVirtualChannelOptions(ByVal chanName As String) As Long

Method GetVirtualChannelOptions(chan name, options)

Function RequestClose() As __MIDL_IMsRdpClient_0002

Method RequestClose()

Events

None

IMsRdpClientAdvancedSettings {3C65B4AB-12B3-465B-ACD4-B8DAD3BFF9E2}

Methods

Property Let Compress(RHS As Long)

property Compress

Property Get Compress() As Long

property Compress

Property Let BitmapPeristence(RHS As Long)

property BitmapPeristence

Property Get BitmapPeristence() As Long

property BitmapPeristence

Property Let allowBackgroundInput(RHS As Long)

property allowBackgroundInput

Property Get allowBackgroundInput() As Long

property allowBackgroundInput

Property Let KeyBoardLayoutStr(RHS As String)

property KeyBoardLayoutStr

Property Let PluginDlls(RHS As String)

property PluginDlls

Property Let IconFile(RHS As String)

property IconFile

Property Let IconIndex(RHS As Long)

property IconIndex

Property Let ContainerHandledFullScreen(RHS As Long)

property ContainerHandledFullScreen

Property Get ContainerHandledFullScreen() As Long

property ContainerHandledFullScreen

Property Let DisableRdpdr(RHS As Long)

property DisableRdpdr

Property Get DisableRdpdr() As Long

property DisableRdpdr

Property Let SmoothScroll(RHS As Long)

property SmoothScroll

Property Get SmoothScroll() As Long

property SmoothScroll

Property Let AcceleratorPassthrough(RHS As Long)

property AcceleratorPassthrough

Property Get AcceleratorPassthrough() As Long

property AcceleratorPassthrough

Property Let ShadowBitmap(RHS As Long)

property ShadowBitmap

Property Get ShadowBitmap() As Long

property ShadowBitmap

Property Let TransportType(RHS As Long)

property TransportType

Property Get TransportType() As Long

property TransportType

Property Let SasSequence(RHS As Long)

property SasSequence

Property Get SasSequence() As Long

property SasSequence

Property Let EncryptionEnabled(RHS As Long)

property EncryptionEnabled

Property Get EncryptionEnabled() As Long

property EncryptionEnabled

Property Let DedicatedTerminal(RHS As Long)

property DedicatedTerminal

Property Get DedicatedTerminal() As Long

property DedicatedTerminal

Property Let RDPPort(RHS As Long)

property RDPPort

Property Get RDPPort() As Long

property RDPPort

Property Let EnableMouse(RHS As Long)

property EnableMouse

Property Get EnableMouse() As Long

property EnableMouse

Property Let DisableCtrlAltDel(RHS As Long)

property DisableCtrlAltDel

Property Get DisableCtrlAltDel() As Long

property DisableCtrlAltDel

Property Let EnableWindowsKey(RHS As Long)

property EnableWindowsKey

Property Get EnableWindowsKey() As Long

property EnableWindowsKey

Property Let DoubleClickDetect(RHS As Long)

property DoubleClickDetect

Property Get DoubleClickDetect() As Long

property DoubleClickDetect

Property Let MaximizeShell(RHS As Long)

property MaximizeShell

Property Get MaximizeShell() As Long

property MaximizeShell

Property Let HotKeyFullScreen(RHS As Long)

property HotKeyFullScreen

Property Get HotKeyFullScreen() As Long

property HotKeyFullScreen

Property Let HotKeyCtrlEsc(RHS As Long)

property HotKeyCtrlEsc

Property Get HotKeyCtrlEsc() As Long

property HotKeyCtrlEsc

Property Let HotKeyAltEsc(RHS As Long)

property HotKeyAltEsc

Property Get HotKeyAltEsc() As Long

property HotKeyAltEsc

Property Let HotKeyAltTab(RHS As Long)

property HotKeyAltTab

Property Get HotKeyAltTab() As Long

property HotKeyAltTab

Property Let HotKeyAltShiftTab(RHS As Long)

property HotKeyAltShiftTab

Property Get HotKeyAltShiftTab() As Long

property HotKeyAltShiftTab

Property Let HotKeyAltSpace(RHS As Long)

property HotKeyAltSpace

Property Get HotKeyAltSpace() As Long

property HotKeyAltSpace

Property Let HotKeyCtrlAltDel(RHS As Long)

property HotKeyCtrlAltDel

Property Get HotKeyCtrlAltDel() As Long

property HotKeyCtrlAltDel

Property Let orderDrawThreshold(RHS As Long)

property orderDrawThreshold

Property Get orderDrawThreshold() As Long

property orderDrawThreshold

Property Let BitmapCacheSize(RHS As Long)

property BitmapCacheSize

Property Get BitmapCacheSize() As Long

property BitmapCacheSize

Property Let BitmapVirtualCacheSize(RHS As Long)

property BitmapVirtualCacheSize

Property Get BitmapVirtualCacheSize() As Long

property BitmapVirtualCacheSize

Property Let ScaleBitmapCachesByBPP(RHS As Long)

property ScaleBitmapCachesByBPP

Property Get ScaleBitmapCachesByBPP() As Long

property ScaleBitmapCachesByBPP

Property Let NumBitmapCaches(RHS As Long)

property NumBitmapCaches

Property Get NumBitmapCaches() As Long

property NumBitmapCaches

Property Let CachePersistenceActive(RHS As Long)

property CachePersistenceActive

Property Get CachePersistenceActive() As Long

property CachePersistenceActive

Property Let PersistCacheDirectory(RHS As String)

property PersistCacheDirectory

Property Let brushSupportLevel(RHS As Long)

property brushSupportLevel

Property Get brushSupportLevel() As Long

property brushSupportLevel

Property Let minInputSendInterval(RHS As Long)

property minInputSendInterval

Property Get minInputSendInterval() As Long

property minInputSendInterval

Property Let InputEventsAtOnce(RHS As Long)

property InputEventsAtOnce

Property Get InputEventsAtOnce() As Long

property InputEventsAtOnce

Property Let maxEventCount(RHS As Long)

property maxEventCount

Property Get maxEventCount() As Long

property maxEventCount

Property Let keepAliveInterval(RHS As Long)

property keepAliveInterval

Property Get keepAliveInterval() As Long

property keepAliveInterval

Property Let shutdownTimeout(RHS As Long)

property shutdownTimeout

Property Get shutdownTimeout() As Long

property shutdownTimeout

Property Let overallConnectionTimeout(RHS As Long)

property overallConnectionTimeout

Property Get overallConnectionTimeout() As Long

property overallConnectionTimeout

Property Let singleConnectionTimeout(RHS As Long)

property singleConnectionTimeout

Property Get singleConnectionTimeout() As Long

property singleConnectionTimeout

Property Let KeyboardType(RHS As Long)

property KeyboardType

Property Get KeyboardType() As Long

property KeyboardType

Property Let KeyboardSubType(RHS As Long)

property KeyboardSubType

Property Get KeyboardSubType() As Long

property KeyboardSubType

Property Let KeyboardFunctionKey(RHS As Long)

property KeyboardFunctionKey

Property Get KeyboardFunctionKey() As Long

property KeyboardFunctionKey

Property Let WinceFixedPalette(RHS As Long)

property WinceFixedPalette

Property Get WinceFixedPalette() As Long

property WinceFixedPalette

Property Let ConnectToServerConsole(RHS As Boolean)

property ConnectToServerConsole

Property Get ConnectToServerConsole() As Boolean

property ConnectToServerConsole

Property Let BitmapPersistence(RHS As Long)

property BitmapPersistence

Property Get BitmapPersistence() As Long

property BitmapPersistence

Property Let MinutesToIdleTimeout(RHS As Long)

property MinutesToIdleTimeout

Property Get MinutesToIdleTimeout() As Long

property MinutesToIdleTimeout

Property Let SmartSizing(RHS As Boolean)

property SmartSizing

Property Get SmartSizing() As Boolean

property SmartSizing

Property Let RdpdrLocalPrintingDocName(RHS As String)

property RDPDR Local Printing Doc Name

Property Get RdpdrLocalPrintingDocName() As String

property RDPDR Local Printing Doc Name

Property Let RdpdrClipCleanTempDirString(RHS As String)

property RDPDR clean temp directory string

Property Get RdpdrClipCleanTempDirString() As String

property RDPDR clean temp directory string

Property Let RdpdrClipPasteInfoString(RHS As String)

property RDPDR clip paste string

Property Get RdpdrClipPasteInfoString() As String

property RDPDR clip paste string

Property Let ClearTextPassword(RHS As String)

property clear text password (write only)

Property Let DisplayConnectionBar(RHS As Boolean)

property DisplayConnectionBar

Property Get DisplayConnectionBar() As Boolean

property DisplayConnectionBar

Property Let PinConnectionBar(RHS As Boolean)

property PinConnectionBar

Property Get PinConnectionBar() As Boolean

property PinConnectionBar

Property Let GrabFocusOnConnect(RHS As Boolean)

property GrabFocusOnConnect

Property Get GrabFocusOnConnect() As Boolean

property GrabFocusOnConnect

Property Let LoadBalanceInfo(RHS As String)

property LoadBalanceInfo

Property Get LoadBalanceInfo() As String

property LoadBalanceInfo

Property Let RedirectDrives(RHS As Boolean)

property RedirectDrives

Property Get RedirectDrives() As Boolean

property RedirectDrives

Property Let RedirectPrinters(RHS As Boolean)

property RedirectPrinters

Property Get RedirectPrinters() As Boolean

property RedirectPrinters

Property Let RedirectPorts(RHS As Boolean)

property RedirectPorts

Property Get RedirectPorts() As Boolean

property RedirectPorts

Property Let RedirectSmartCards(RHS As Boolean)

property RedirectSmartCards

Property Get RedirectSmartCards() As Boolean

property RedirectSmartCards

Property Let BitmapVirtualCache16BppSize(RHS As Long)

property BitmapVirtualCache16BppSize

Property Get BitmapVirtualCache16BppSize() As Long

property BitmapVirtualCache16BppSize

Property Let BitmapVirtualCache24BppSize(RHS As Long)

property BitmapVirtualCache24BppSize

Property Get BitmapVirtualCache24BppSize() As Long

property BitmapVirtualCache24BppSize

Property Let PerformanceFlags(RHS As Long)

property PerformanceFlags

Property Get PerformanceFlags() As Long

property PerformanceFlags

Property Let ConnectWithEndpoint(RHS As Variant)

property ConnectWithEndpoint

Property Let NotifyTSPublicKey(RHS As Boolean)

property NotifyTSPublicKey

Property Get NotifyTSPublicKey() As Boolean

property NotifyTSPublicKey

Events

None

IMsRdpClientNonScriptable {2F079C4C-87B2-4AFD-97AB-20CDB43038AE}

Methods

Function NotifyRedirectDeviceChange(ByVal wParam As ULong, ByVal lParam As Long) As ???

Method NotifyRedirectDeviceChange(wParam, lParam)

Function SendKeys(ByVal numKeys As Long, ByVal pbArrayKeyUp As Boolean, ByVal plKeyData As Long) As ???

Method SendKeys

Events

None

IMsRdpClientSecuredSettings {605BEFCF-39C1-45CC-A811-068FB7BE346D}

Methods

Property Let StartProgram(RHS As String)

property StartProgram

Property Get StartProgram() As String

property StartProgram

Property Let WorkDir(RHS As String)

property Working Directory

Property Get WorkDir() As String

property Working Directory

Property Let FullScreen(RHS As Long)

propery full screen mode

Property Get FullScreen() As Long

propery full screen mode

Property Let KeyboardHookMode(RHS As Long)

property KeyboardHookMode

Property Get KeyboardHookMode() As Long

property KeyboardHookMode

Property Let AudioRedirectionMode(RHS As Long)

property AudioRedirectionMode

Property Get AudioRedirectionMode() As Long

property AudioRedirectionMode

Events

None

IMsTscAdvancedSettings {809945CC-4B3B-4A92-A6B0-DBF9B5F2EF2D}

Methods

Property Let Compress(RHS As Long)

property Compress

Property Get Compress() As Long

property Compress

Property Let BitmapPeristence(RHS As Long)

property BitmapPeristence

Property Get BitmapPeristence() As Long

property BitmapPeristence

Property Let allowBackgroundInput(RHS As Long)

property allowBackgroundInput

Property Get allowBackgroundInput() As Long

property allowBackgroundInput

Property Let KeyBoardLayoutStr(RHS As String)

property KeyBoardLayoutStr

Property Let PluginDlls(RHS As String)

property PluginDlls

Property Let IconFile(RHS As String)

property IconFile

Property Let IconIndex(RHS As Long)

property IconIndex

Property Let ContainerHandledFullScreen(RHS As Long)

property ContainerHandledFullScreen

Property Get ContainerHandledFullScreen() As Long

property ContainerHandledFullScreen

Property Let DisableRdpdr(RHS As Long)

property DisableRdpdr

Property Get DisableRdpdr() As Long

property DisableRdpdr

Events

None

IMsTscAx {327BB5CD-834E-4400-AEF2-B30E15E5D682}

Methods

Property Let Server(RHS As String)

property Server

Property Get Server() As String

property Server

Property Let Domain(RHS As String)

property Domain

Property Get Domain() As String

property Domain

Property Let UserName(RHS As String)

property UserName

Property Get UserName() As String

property UserName

Property Let DisconnectedText(RHS As String)

property DisconnectedText

Property Get DisconnectedText() As String

property DisconnectedText

Property Let ConnectingText(RHS As String)

property ConnectingText

Property Get ConnectingText() As String

property ConnectingText

Property Get Connected() As Integer

property Connected

Property Let DesktopWidth(RHS As Long)

propery Desktop width

Property Get DesktopWidth() As Long

propery Desktop width

Property Let DesktopHeight(RHS As Long)

propery Desktop Height

Property Get DesktopHeight() As Long

propery Desktop Height

Property Let StartConnected(RHS As Long)

propery start connected

Property Get StartConnected() As Long

propery start connected

Property Get HorizontalScrollBarVisible() As Long

propery HorizontalScrollBarVisible

Property Get VerticalScrollBarVisible() As Long

propery VerticalScrollBarVisible

Property Let FullScreenTitle(RHS As String)

propery FullScreenTitle

Property Get CipherStrength() As Long

propery CipherStrength

Property Get Version() As String

propery Version

Property Get SecuredSettingsEnabled() As Long

propery SecuredSettingsEnabled

Property Get SecuredSettings() As IMsTscSecuredSettings

propery get secured settings

Property Get AdvancedSettings() As IMsTscAdvancedSettings

propery get advanced settings

Sub Connect

Method Connect

Sub Disconnect

Method Disconnect

Sub CreateVirtualChannels(ByVal newVal As String)

Method CreateVirtualChannels

Sub SendOnVirtualChannel(ByVal chanName As String, ByVal ChanData As String)

Method SendOnVirtualChannel(chan name, data)

Events

None

IMsTscAxEvents {336D5562-EFA8-482E-8CB3-C5C0FC7A7DB6}

Methods

Sub OnConnecting

Sub OnConnected

Sub OnLoginComplete

Sub OnDisconnected(ByVal discReason As Long)

Sub OnEnterFullScreenMode

Sub OnLeaveFullScreenMode

Sub OnChannelReceivedData(ByVal chanName As String, ByVal data As String)

Sub OnRequestGoFullScreen

Sub OnRequestLeaveFullScreen

Sub OnFatalError(ByVal errorCode As Long)

Sub OnWarning(ByVal warningCode As Long)

Sub OnRemoteDesktopSizeChange(ByVal width As Long, ByVal height As Long)

Sub OnIdleTimeoutNotification

Sub OnRequestContainerMinimize

Function OnConfirmClose() As Boolean

Function OnReceivedTSPublicKey(ByVal publicKey As String) As Boolean

Events

None

IMsTscDebug {209D0EB9-6254-47B1-9033-A98DAE55BB27}

Methods

Property Let HatchBitmapPDU(RHS As Long)

property HatchBitmapPDU

Property Get HatchBitmapPDU() As Long

property HatchBitmapPDU

Property Let HatchSSBOrder(RHS As Long)

property HatchSSBOrder

Property Get HatchSSBOrder() As Long

property HatchSSBOrder

Property Let HatchMembltOrder(RHS As Long)

property HatchMembltOrder

Property Get HatchMembltOrder() As Long

property HatchMembltOrder

Property Let HatchIndexPDU(RHS As Long)

property HatchIndexPDU

Property Get HatchIndexPDU() As Long

property HatchIndexPDU

Property Let LabelMemblt(RHS As Long)

property LabelMemblt

Property Get LabelMemblt() As Long

property LabelMemblt

Property Let BitmapCacheMonitor(RHS As Long)

property BitmapCacheMonitor

Property Get BitmapCacheMonitor() As Long

property BitmapCacheMonitor

Property Let MallocFailuresPercent(RHS As Long)

property MallocFailuresPercent

Property Get MallocFailuresPercent() As Long

property MallocFailuresPercent

Property Let MallocHugeFailuresPercent(RHS As Long)

property MallocHugeFailuresPercent

Property Get MallocHugeFailuresPercent() As Long

property MallocHugeFailuresPercent

Property Let NetThroughput(RHS As Long)

property NetThroughput

Property Get NetThroughput() As Long

property NetThroughput

Property Let CLXCmdLine(RHS As String)

property CLXCmdLine

Property Get CLXCmdLine() As String

property CLXCmdLine

Property Let CLXDll(RHS As String)

property CLXDll

Property Get CLXDll() As String

property CLXDll

Events

None

IMsTscNonScriptable {C1E6743A-41C1-4A74-832A-0DD06C1C7A0E}

Methods

Property Let ClearTextPassword(RHS As String)

property (set only) ClearTextPassword

Property Let PortablePassword(RHS As String)

propterty PortablePassword

Property Get PortablePassword() As String

propterty PortablePassword

Property Let PortableSalt(RHS As String)

propterty PortableSalt

Property Get PortableSalt() As String

propterty PortableSalt

Property Let BinaryPassword(RHS As String)

propterty BinaryPassword

Property Get BinaryPassword() As String

propterty BinaryPassword

Property Let BinarySalt(RHS As String)

property BinarySalt

Property Get BinarySalt() As String

property BinarySalt

Function ResetPassword() As ???

Method ResetPassword

Events

None

IMsTscSecuredSettings {C9D65442-A0F9-45B2-8F73-D61D2DB8CBB6}

Methods

Property Let StartProgram(RHS As String)

property StartProgram

Property Get StartProgram() As String

property StartProgram

Property Let WorkDir(RHS As String)

property Working Directory

Property Get WorkDir() As String

property Working Directory

Property Let FullScreen(RHS As Long)

propery full screen mode

Property Get FullScreen() As Long

propery full screen mode

Events

None

LONG_PTR {00000000-0000-0000-0000-000000000000}

MethodsNone

Events

None

MsRdpClient {791FA017-2DE3-492E-ACC5-53C67A2B94D0}

MethodsNone

Events

None

MsTscAx {1FB464C8-09BB-4017-A2F5-EB742F04392F}

MethodsNone

Events

None

UINT_PTR {00000000-0000-0000-0000-000000000000}

MethodsNone

Events

None