MsRdpClient12-Klasse

Artikel
10/02/2023

Microsoft RDP-Clientsteuerung (verteilbar) – Version 13

Diese Klasse implementiert die folgenden Schnittstellen.

MsRdpClient12 verfügt über folgende Membertypen:

Methoden
Eigenschaften

Methoden

Die MsRdpClient12-Klasse verfügt über diese Methoden.

Methode	Beschreibung
attachEvent	Fügt ein Ereignis an.
Verbinden	Initiiert eine Verbindung mithilfe der eigenschaften, die derzeit für das Steuerelement festgelegt sind.
CreateVirtualChannels	Erstellt ein clientseitiges virtuelles Kanalobjekt für jeden angegebenen namen des virtuellen Kanals.
detachEvent	Trennt ein Ereignis.
Trennen	Trennt die aktive Verbindung.
GetErrorDescription	Ruft die Fehlercodes und Fehlermeldungen ab.
GetStatusText	Ruft den status Text für den angegebenen status Code ab.
GetVirtualChannelOptions	Ruft die für einen virtuellen Kanal festgelegten Optionen ab.
NotifyRedirectDeviceChange	Benachrichtigt das Modul für die Geräteumleitung des ActiveX-Remotedesktopsteuerelements, dass eine Geräteänderung auf dem System erfolgt ist. Diese Methode übergibt WM_DEVICECHANGE Benachrichtigungen an das Steuerelement.
OnAuthenticationWarningDismissed	Wird aufgerufen, nachdem ein ActiveX-Steuerelement ein Authentifizierungsdialogfeld anzeigt (z. B. das Zertifikatfehlerdialogfeld).
OnAuthenticationWarningDisplayed	Wird aufgerufen, bevor ein ActiveX-Steuerelement ein Authentifizierungsdialogfeld anzeigt (z. B. das Dialogfeld "Zertifikatfehler").
OnAutoReconnected	Wird aufgerufen, wenn das Clientsteuerelement automatisch wieder eine Verbindung mit einer Remotesitzung hergestellt hat.
OnAutoReconnecting	Wird aufgerufen, wenn ein Client gerade dabei ist, eine Sitzung automatisch wieder mit einem RD-Sitzungshostserver zu verbinden.
OnAutoReconnecting2	Wird aufgerufen, wenn ein Client gerade dabei ist, eine Sitzung automatisch wieder mit einem RD-Sitzungshostserver zu verbinden.
OnChannelReceivedData	Wird aufgerufen, wenn der Client Daten in einem skriptfähigen virtuellen Kanal empfängt.
OnConfirmClose	Wird aufgerufen, wenn der Client die IMsRdpClient::RequestClose-Methode aufruft.
OnConnected	Wird aufgerufen, wenn das Clientsteuerelement gerade eine Verbindung mit einem RD-Sitzungshostserver herstellt.
OnConnecting	Wird aufgerufen, wenn das Clientsteuerelement als Reaktion auf einen Aufruf von IMsTscAx::Connect eine Verbindung mit einem Server herstellt.
OnConnectionBarPullDown	Wird aufgerufen, wenn der Benutzer auf der Verbindungsleiste nach unten gezogen wurde.
OnDevicesButtonPressed	Wird aufgerufen, wenn die Geräteschaltfläche in der Verbindungsleiste gedrückt wurde.
OnDisconnected	Wird aufgerufen, wenn die Verbindung zwischen dem Clientsteuerelement und dem RD-Sitzungshostserver getrennt wurde.
OnEnterFullScreenMode	Wird aufgerufen, wenn der Client in den Vollbildmodus wechselt. Dieses Ereignis wird beispielsweise aufgerufen, wenn der Benutzer die Tastenkombination im Vollbildmodus (STRG+ALT+BREAK) drückt.
OnFatalError	Wird aufgerufen, wenn für das Clientsteuerelement ein schwerwiegender Fehler auftritt.
OnFocusReleased	Wird aufgerufen, wenn die Tastenkombination "Freigabefokus" gedrückt wird. Dieses Ereignis wird beispielsweise aufgerufen, wenn der Benutzer STRG+ALT+NACH-LINKS-TASTE oder STRG+ALT+NACH-RECHTS-TASTE drückt.
OnIdleTimeoutNotification	Wird aufgerufen, wenn der Benutzer während des von der IMsRdpClientAdvancedSettings::p ut_MinutesToIdleTimeout-Methode festgelegten Zeitraums keine Maus- oder Tastatureingaben ausgeführt hat.
OnLeaveFullScreenMode	Wird aufgerufen, wenn der Client den Vollbildmodus verlässt. Dieses Ereignis wird beispielsweise aufgerufen, wenn der Benutzer die Tastenkombination im Vollbildmodus (STRG+ALT+BREAK) drückt.
OnLoginComplete	Wird aufgerufen, wenn sich das Clientsteuerelement erfolgreich bei einem RD-Sitzungshostserver angemeldet hat, und zwar nach der Anzeige des Dialogfelds Windows-Anmeldung.
OnLogonError	Wird aufgerufen, wenn ein Anmeldefehler oder ein anderes Anmeldeereignis auftritt.
OnMouseInputModeChanged	Wird aufgerufen, wenn sich der Mauseingabemodus geändert hat.
OnNetworkStatusChanged	Wird aufgerufen, wenn sich das Netzwerk status geändert hat.
OnReceivedTSPublicKey	Wird während der Verbindungssequenz aufgerufen, wenn der Client den öffentlichen Schlüssel vom Server abruft. Dieses Ereignis wird nur aufgerufen, wenn die NotifyTSPublicKey-EigenschaftVARIANT_TRUE ist.
OnRemoteDesktopSizeChange	Wird aufgerufen, um anzugeben, dass sich die Größe des Clientsteuerelements auf dem Remotedesktop als Reaktion auf einen Clientsteuerungsvorgang geändert hat.
OnRemoteProgramDisplayed	Wird aufgerufen, wenn ein RemoteApp-Programm angezeigt wird.
OnRemoteProgramResult	Wird aufgerufen, wenn ein RemoteApp-Programm ein Ergebnis an das Clientsteuerelement zurückgibt.
OnRemoteWindowDisplayed	Wird aufgerufen, wenn ein RemoteApp-Fenster angezeigt wird.
OnRequestContainerMinimize	Wird aufgerufen, wenn der Benutzer die Schaltfläche Minimieren auf der Verbindungsleiste im Vollbildmodus drückt. Das Auslösen dieses Ereignisses ist eine Anforderung, die die Containeranwendung selbst minimiert.
OnRequestGoFullScreen	Wird aufgerufen, wenn der Client anfordert, in den Vollbildmodus zu wechseln, und die IMsTscAdvancedSettings::p ut_ContainerHandledFullScreen-Methode aufgerufen wird, um die ContainerHandledFullScreen-Eigenschaft auf einen Wert ungleich null festzulegen.
OnRequestLeaveFullScreen	Wird aufgerufen, wenn der Client anfordert, den Vollbildmodus zu verlassen, und die IMsTscAdvancedSettings::p ut_ContainerHandledFullScreen-Eigenschaft auf einen Wert ungleich null festgelegt wurde.
OnServiceMessageReceived	Wird aufgerufen, wenn der Client eine Systemnachricht empfängt.
OnUserNameAcquired	Wird aufgerufen, wenn der Benutzername vom Steuerelement abgerufen wurde.
OnWarning	Wird aufgerufen, wenn für das Clientsteuerelement eine Fehlerbedingung auftritt, die nicht schwerwiegend ist.
Verbindung wiederherstellen	Stellt erneut eine Verbindung mit der Remotesitzung mit der neuen Desktopbreite und -höhe her.
RequestClose	Fordert ein ordnungsgemäßes Herunterfahren des Clientsteuerelements an.
Resetpassword	Setzt alle Kennwortzustände im Steuerelement zurück.
SendKeys	Sendet eine Reihe von Tastenanschlägen an das Steuerelement. Die Tastaturanschläge befinden sich im Scancodeformat, d. h. die Tastaturdaten der tatsächlichen physischen Tasten.
SendOnVirtualChannel	Sendet Daten über einen virtuellen Kanal, der zuvor mit der IMsTscAx::CreateVirtualChannels-Methode erstellt wurde, an den RD-Sitzungshostserver.
SendRemoteAction	Bewirkt, dass eine Aktion in der Remotesitzung ausgeführt wird.
SetVirtualChannelOptions	Legt die Optionen für den virtuellen Kanal für das Clientsteuerelement fest.
SyncSessionDisplaySettings	Synchronisiert Sitzungsanzeigeeinstellungen.
UpdateSessionDisplaySettings	Updates Sitzungsanzeigeeinstellungen.
SendLocation2D	Sendet einen Breiten- und Längengrad an den Server, damit der geografische Standort des Clients in der Remotesitzung widergespiegelt werden kann.
SendLocation3D	Sendet einen Breiten-, Längen- und Höhenwert an den Server, damit der geografische Standort des Clients in der Remotesitzung widergespiegelt werden kann.
DisableDpiCursorScalingForProcess	Deaktiviert die lokale Skalierung des Mauscursors, der vom Server empfangen wird, und stellt sicher, dass die Cursorform ohne Änderung ordnungsgemäß gerendert wird.
StartWorkspaceExtension	Koordiniert die Remotesitzung des Clients mit der Systemsteuerung RemoteApp- und Desktopverbindungen.

Eigenschaften

Die MsRdpClient12-Klasse verfügt über diese Eigenschaften.

Eigenschaft	Zugriffstyp	BESCHREIBUNG
AdvancedSettings	Schreibgeschützt	Ein IMsTscAdvancedSettings-Schnittstellenzeiger .
AdvancedSettings2	Schreibgeschützt	Zeiger auf die IMsRdpClientAdvancedSettings-Schnittstelle , die zum Festlegen erweiterter Einstellungen für das Clientsteuerelement verwendet wird.
AdvancedSettings3	Schreibgeschützt	Zeiger auf die IMsRdpClientAdvancedSettings2-Schnittstelle , die zum Festlegen erweiterter Einstellungen für das Clientsteuerelement verwendet wird.
AdvancedSettings4	Schreibgeschützt	Zeiger auf die IMsRdpClientAdvancedSettings3-Schnittstelle , die zum Festlegen erweiterter Einstellungen für das Clientsteuerelement verwendet wird.
AdvancedSettings5	Schreibgeschützt	Ein IMsRdpClientAdvancedSettings4-Schnittstellenzeiger .
AdvancedSettings6	Schreibgeschützt	Die Schnittstelle zu IMsRdpClientAdvancedSettings5.
AdvancedSettings7	Schreibgeschützt	Die Schnittstelle zu IMsRdpClientAdvancedSettings6.
AdvancedSettings8	Schreibgeschützt	Ein -Objekt, das die IMsRdpClientAdvancedSettings7-Schnittstelle unterstützt.
AdvancedSettings9	Schreibgeschützt	Eine IMsRdpClientAdvancedSettings8-Schnittstelle , die das settings-Objekt darstellt.
AllowCredentialSaving	Lesen/Schreiben	Gibt an, ob im Dialogfeld Anmeldeinformationen ein Kontrollkästchen zum Aktivieren des Speicherns von Anmeldeinformationen angezeigt wird.
AllowPromptingForCredentials	Lesen/Schreiben	Gibt an, ob das ActiveX-Remotedesktop-Steuerelement den Benutzer zur Eingabe von Anmeldeinformationen auffordern kann.
BinaryPassword	Lesen/Schreiben	Diese Eigenschaft wird nicht unterstützt.
BinarySalt	Lesen/Schreiben	Diese Eigenschaft wird nicht unterstützt.
CipherStrength	Schreibgeschützt	Die maximale Verschlüsselungsstärke des aktuellen Steuerelements.
ClearTextPassword	Lesegeschützt	Das Remotedesktop-ActiveX-Steuerelementkennwort im Klartextformat.
ColorDepth	Lesen/Schreiben	Farbtiefe des aktuellen Steuerelements.
Verbunden	Schreibgeschützt	Der Verbindungsstatus des aktuellen Steuerelements.
ConnectedStatusText	Lesen/Schreiben	Text, der im Clientbereich des Steuerelements angezeigt wird, während sich das Steuerelement im verbundenen Zustand befindet.
ConnectingText	Lesen/Schreiben	Der Text, der zentriert im Steuerelement angezeigt wird, während das Steuerelement eine Verbindung herstellt.
ConnectionBarText	Lesen/Schreiben	Die Textzeichenfolge, die für die Verbindungsleiste angezeigt werden soll.
DesktopHeight	Lesen/Schreiben	Die Höhe des aktuellen Steuerelements in Pixel auf dem ersten Remotedesktop.
DesktopWidth	Lesen/Schreiben	Die Breite des aktuellen Steuerelements in Pixel auf dem ersten Remotedesktop.
DeviceCollection	Schreibgeschützt	Die Sammlung von PnP-Geräten, die für die Umleitung verfügbar sind.
DisableConnectionBar	Lesegeschützt	Gibt an, ob das ActiveX-Remotedesktopsteuerelement die Verbindungsleiste deaktivieren soll.
DisableRemoteAppCapsCheck	Lesen/Schreiben	Gibt an, ob das ActiveX-Remotedesktopsteuerelement den Server nicht auf RemoteApp-Funktionen überprüfen soll.
DisconnectedText	Lesen/Schreiben	Der Text, der im Steuerelement zentriert angezeigt wird, bevor eine Verbindung beendet wird.
Domain	Lesen/Schreiben	Die Domäne, bei der sich der aktuelle Benutzer anmeldet.
DriveCollection	Schreibgeschützt	Die Sammlung von Datenträgern, die für die Umleitung verfügbar sind.
EnableCredSspSupport	Lesen/Schreiben	Gibt an, ob CredSSP für diese Verbindung aktiviert ist.
ExtendedDisconnectReason	Schreibgeschützt	Erweiterte Informationen zum Grund für die Trennung des Clientsteuerelements.
Fullscreen	Lesen/Schreiben	Gibt an, ob sich das Steuerelement im Vollbildmodus befindet.
FullScreenTitle	Lesegeschützt	Der Fenstertitel, der angezeigt wird, wenn sich das Steuerelement im Vollbildmodus befindet.
GetRemoteMonitorsBoundingBox	Schreibgeschützt	Gibt das umgebende Rechteck des Remotemonitors an.
HorizontalScrollBarVisible	Schreibgeschützt	Gibt an, ob das Steuerelement eine horizontale Bildlaufleiste angezeigt hat.
GestartetViaClientShellInterface	Lesen/Schreiben	Gibt an, ob der Benutzer das Clientsteuerelement mithilfe der Web Access-Schnittstelle für Remotedesktope gestartet hat.
MarkRdpSettingsSecure	Lesen/Schreiben	Gibt an, ob RDP-Einstellungen als sicher gekennzeichnet sind.
MsRdpClientShell	Schreibgeschützt	Die Clienteinstellungen für das Webportal-Startprogramm.
NegotiateSecurityLayer	Lesen/Schreiben	Gibt an, ob die NegotiateSecurityLayer-Einstellung für diese Verbindung unterstützt wird. Hinweis: Wenn CredSspSupport aktiviert und auf dem Client vorhanden ist oder SSL (Secure Sockets Layer) mit Benutzerauthentifizierung aktiviert ist, wird NegotiateSecurityLayer ignoriert.
PortablePassword	Lesen/Schreiben	Diese Eigenschaft wird nicht unterstützt.
PortableSalt	Lesen/Schreiben	Diese Eigenschaft wird nicht unterstützt.
PromptForCredentials	Lesen/Schreiben	Gibt an, ob das Dialogfeld "Anmeldeinformationen" angezeigt werden soll.
PromptForCredsOnClient	Lesen/Schreiben	Gibt an, ob das Clientsteuerelement ein Dialogfeld anzeigt, das zur Eingabe von Anmeldeinformationen auffordert.
PublisherCertificateChain	Lesen/Schreiben	Gibt die Zertifikatkette des Herausgebers an. Die Kette wird in einer Variante vom Typ VT_BYREF gespeichert, die einen Zeiger auf eine CERT_CHAIN_CONTEXT-Struktur enthält.
RedirectDynamicDevices	Lesen/Schreiben	Gibt an, ob dynamisch angefügte PnP-Geräte, die während einer Sitzung aufgelistet werden, für die Umleitung verfügbar sind.
RedirectDynamicDrives	Lesen/Schreiben	Gibt an, ob dynamisch angefügte PnP-Laufwerke, die während einer Sitzung aufgelistet werden, für die Umleitung verfügbar sind.
RedirectionWarningType	Lesen/Schreiben	Steuert das Vorhandensein und die Darstellung des Umleitungsdialogfelds.
RemoteMonitorCount	Schreibgeschützt	Gibt die Anzahl der Remotemonitore an.
RemoteMonitorLayoutMatchesLocal	Schreibgeschützt	Gibt an, ob das Remotemonitorlayout mit dem lokalen Monitorlayout identisch ist.
RemoteProgramm	Schreibgeschützt	Die RemoteApp-Einstellung des Clients.
RemoteProgramm2	Schreibgeschützt	Ein -Objekt, das die ITSRemoteProgram2-Schnittstelle unterstützt.
RemoteProgramm3	Schreibgeschützt	Ein -Objekt, das die ITSRemoteProgram3-Schnittstelle unterstützt.
SecuredSettings	Schreibgeschützt	Ein IMsTscSecuredSettings-Schnittstellenzeiger .
SecuredSettings2	Schreibgeschützt	Zeiger auf die IMsRdpClientSecuredSettings-Schnittstelle , die zum Festlegen gesicherter Einstellungen für das Clientsteuerelement verwendet wird.
SecuredSettings3	Schreibgeschützt	Ein Objekt, das die IMsRdpClientSecuredSettings2-Schnittstelle unterstützt.
SecuredSettingsEnabled	Schreibgeschützt	Gibt an, ob die IMsTscSecuredSettings-Schnittstelle verfügbar ist.
Server	Lesen/Schreiben	Der Name des Servers, mit dem das aktuelle Steuerelement verbunden ist.
ShowRedirectionWarningDialog	Lesen/Schreiben	Gibt an, ob das Dialogfeld "Umleitungssicherheitswarnung" angezeigt werden soll, bevor eine Sitzung gestartet wird.
StartConnected	Lesen/Schreiben	Gibt an, ob das Steuerelement die RD-Sitzungshostserververbindung sofort nach dem Start herstellt.
TransportSettings	Schreibgeschützt	Die Client-RD-Gatewayeinstellung.
TransportSettings2	Schreibgeschützt	Die Schnittstelle zu IMsRdpClientTransportSettings2.
TransportSettings3	Schreibgeschützt	Ein -Objekt, das die IMsRdpClientTransportSettings3-Schnittstelle unterstützt.
TransportSettings4	Schreibgeschützt	Ein -Objekt, das die IMsRdpClientTransportSettings4-Schnittstelle unterstützt.
TrustedZoneSite	Lesen/Schreiben	Gibt an, ob sich die Website, von der aus der Benutzer die Verbindung gestartet hat, in der Liste der vertrauenswürdigen Websites des Clientcomputers befindet.
UIParentWindowHandle	Lesen/Schreiben	Das Fensterhandle, das das übergeordnete Fenster für das Steuerelement sein soll. Dadurch können alle fenster, die vom Steuerelement angezeigt werden, in Bezug auf alle Fenster, die von der übergeordneten Anwendung angezeigt werden, ordnungsgemäß modal sein.
UseMultimon	Lesen/Schreiben	Gibt an, ob das ActiveX-Remotedesktopsteuerelement mehrere Monitore verwenden soll.
UseRedirectionServerName	Lesen/Schreiben	Gibt an, ob der Name des Umleitungsservers verwendet werden soll.
Nutzername	Lesen/Schreiben	Die Anmeldeinformationen für den Benutzernamen.
Version	Schreibgeschützt	Die Versionsnummer des aktuellen Steuerelements.
VerticalScrollBarVisible	Schreibgeschützt	Gibt an, ob das Steuerelement eine vertikale Bildlaufleiste anzeigt.
WarnAboutClipboardRedirection	Lesen/Schreiben	Gibt an, ob das Dialogfeld "Sicherheitswarnung" eine Warnung zur Zwischenablageumleitung enthalten soll, bevor eine Sitzung gestartet wird.
WarnAboutDirectXRedirection	Lesen/Schreiben	Diese Eigenschaft wird nicht verwendet.
WarnAboutPrinterRedirection	Lesen/Schreiben	Gibt an, ob im Dialogfeld "Umleitung" eine Meldung zur Druckerumleitung angezeigt wird, bevor eine Sitzung gestartet wird.
WarnAboutSendingCredentials	Lesen/Schreiben	Gibt an, ob die Sicherheitswarnung eine Warnung zum Senden von Anmeldeinformationen an den Remoteserver enthalten soll, bevor eine Sitzung gestartet wird.
CameraRedirConfigCollection	Schreibgeschützt	Ruft die Sammlung von Kameras (und den zugehörigen Konfigurationen) ab, die für die Umleitung verfügbar sind.
Zwischenablage	Schreibgeschützt	Ruft den Zwischenablagecontroller ab, der zum Synchronisieren der lokalen und Remoteablage verwendet wird, wenn die manuelle Zwischenablagesynchronisierung aktiviert ist.
CorrelationId	Schreibgeschützt	Ruft eine GUID ab, die die Remotesitzung des Clients eindeutig identifiziert.
SupportsWorkspaceReconnect	Lesegeschützt	Informiert das ActiveX-Remotedesktopsteuerelement darüber, dass die Remotesitzung des Clients Teil einer Verbindung im Systemsteuerungsbereich RemoteApp- und Desktopverbindungen ist, die die erneute Verbindung unterstützt.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 10 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2016
Typbibliothek	MsTscAx.dll
DLL	MsTscAx.dll
CLSID	CLSID_MsRdpClient12 ist definiert als 945EE98E-B376-4EC2-B2E5-64C9410F93B7

Weitere Informationen

ActiveX-Remotedesktop-Steuerelementklassen