Поделиться через


Класс MsRdpClient12

Клиентский элемент управления Microsoft RDP (распространяемый) — версия 13

Этот класс реализует следующие интерфейсы.

MsRdpClient12 имеет следующие типы элементов:

Методы

Класс MsRdpClient12 содержит следующие методы.

Метод Описание
attachEvent Присоединяет событие.
Подключения Инициирует подключение с помощью свойств, заданных в данный момент в элементе управления .
CreateVirtualChannels Создает объект виртуального канала на стороне клиента для каждого указанного имени виртуального канала.
detachEvent Отсоединяет событие.
Отключение Отключает активное подключение.
GetErrorDescription Извлекает коды ошибок и сообщения об ошибках.
GetStatusText Извлекает текст состояния для указанного кода состояния.
GetVirtualChannelOptions Извлекает набор параметров для виртуального канала.
NotifyRedirectDeviceChange Уведомляет модуль перенаправления устройств элемента ActiveX удаленного рабочего стола о том, что в системе произошло изменение устройства. Этот метод передает WM_DEVICECHANGE уведомления элементу управления.
OnAuthenticationWarningDismissed Вызывается после того, как элемент ActiveX отображает диалоговое окно проверки подлинности (например, диалоговое окно ошибки сертификата).
OnAuthenticationWarningDisplayed Вызывается перед отображением диалогового окна проверки подлинности элемента ActiveX (например, диалогового окна ошибки сертификата).
OnAutoReconnected Вызывается при автоматическом повторном подключении клиентского элемента управления к удаленному сеансу.
OnAutoReconnecting Вызывается, когда клиент находится в процессе автоматического повторного подключения сеанса к серверу узла сеансов удаленных рабочих стола.
OnAutoReconnecting2 Вызывается, когда клиент находится в процессе автоматического повторного подключения сеанса к серверу узла сеансов удаленных рабочих стола.
OnChannelReceivedData Вызывается, когда клиент получает данные в виртуальном канале с поддержкой сценариев.
OnConfirmClose Вызывается, когда клиент вызывает метод IMsRdpClient::RequestClose .
OnConnected Вызывается, когда клиентский элемент управления находится в процессе установления соединения с сервером узла сеансов удаленных рабочих стола.
OnConnecting Вызывается, когда клиентский элемент управления начинает подключение к серверу в ответ на вызов IMsTscAx::Connect.
OnConnectionBarPullDown Вызывается при перетаскивании пользователя на панели подключения.
OnDevicesButtonPressed Вызывается при нажатии кнопки устройств на панели подключения.
OnDisconnected Вызывается при отключении клиентского элемента управления от сервера узла сеансов удаленных рабочих стола.
OnEnterFullScreenMode Вызывается, когда клиент переходит в полноэкранный режим. Например, это событие вызывается, когда пользователь нажимает сочетание клавиш в полноэкранном режиме (CTRL+ALT+BREAK).
OnFatalError Вызывается, когда клиентский элемент управления обнаруживает неустранимую ошибку.
OnFocusReleased Вызывается при нажатии сочетания клавиш с фокусом освобождения. Например, это событие вызывается, когда пользователь нажимает сочетание клавиш CTRL+ALT+СТРЕЛКА ВЛЕВО или CTRL+ALT+СТРЕЛКА ВПРАВО.
OnIdleTimeoutNotification Вызывается, если пользователь не вводил данные с помощью мыши или клавиатуры в течение периода времени, заданного методом IMsRdpClientAdvancedSettings::p ut_MinutesToIdleTimeout .
OnLeaveFullScreenMode Вызывается, когда клиент выходит из полноэкранного режима. Например, это событие вызывается, когда пользователь нажимает сочетание клавиш в полноэкранном режиме (CTRL+ALT+BREAK).
OnLoginComplete Вызывается при успешном входе клиентского элемента управления на сервер узла сеансов удаленных рабочих стола после отображения диалогового окна Вход в Windows.
OnLogonError Вызывается при возникновении ошибки входа или другого события входа.
OnMouseInputModeChanged Вызывается при изменении режима ввода с помощью мыши.
OnNetworkStatusChanged Вызывается при изменении состояния сети.
OnReceivedTSPublicKey Вызывается во время последовательности подключения, когда клиент получает открытый ключ с сервера. Это событие вызывается, только если свойство NotifyTSPublicKeyVARIANT_TRUE.
OnRemoteDesktopSizeChange Вызывается для указания того, что размер клиентского элемента управления на удаленном рабочем столе изменился в ответ на операцию клиентского управления.
OnRemoteProgramDisplayed Вызывается при отображении программы RemoteApp.
OnRemoteProgramResult Вызывается, когда программа RemoteApp возвращает результат клиентскому элементу управления.
OnRemoteWindowDisplayed Вызывается при отображении окна RemoteApp.
OnRequestContainerMinimize Вызывается, когда пользователь нажимает кнопку Свернуть на панели подключения в полноэкранном режиме. Запуск этого события — это запрос, который приложение-контейнер минимизирует себя.
OnRequestGoFullScreen Вызывается, когда клиент запрашивает переключение в полноэкранный режим, а метод IMsTscAdvancedSettings::p ut_ContainerHandledFullScreen вызывается для задания свойства ContainerHandledFullScreen ненулевого значения.
OnRequestLeaveFullScreen Вызывается, когда клиент запрашивает выход из полноэкранного режима, а свойству IMsTscAdvancedSettings::p ut_ContainerHandledFullScreen присвоено ненулевое значение.
OnServiceMessageReceived Вызывается, когда клиент получает системное сообщение.
OnUserNameAcquired Вызывается, когда имя пользователя было приобретено элементом управления .
OnWarning Вызывается, когда клиентский элемент управления обнаруживает ошибку, которая не является неустранимой.
Повтор соединения Повторно подключается к удаленному сеансу с новой шириной и высотой рабочего стола.
RequestClose Запрашивает корректное завершение работы клиентского элемента управления.
ResetPassword Сбрасывает все состояния паролей в элементе управления .
SendKeys Отправляет ряд нажатий клавиш элементу управления. Нажатия клавиш находятся в форме кода сканирования, которая представляет собой данные клавиатуры из фактических физических клавиш.
SendOnVirtualChannel Отправляет данные на сервер узла сеансов удаленных рабочих стола по виртуальному каналу, который был создан ранее с помощью метода IMsTscAx::CreateVirtualChannels .
SendRemoteAction Вызывает выполнение действия в удаленном сеансе.
SetVirtualChannelOptions Задает параметры виртуального канала для клиентского элемента управления.
SyncSessionDisplaySettings Синхронизирует параметры отображения сеанса.
UpdateSessionDisplaySettings Обновления параметры отображения сеанса.
SendLocation2D Отправляет на сервер значения широты и долготы, чтобы географическое расположение клиента можно было отразить в удаленном сеансе.
SendLocation3D Отправляет на сервер значения широты, долготы и высоты, чтобы географическое расположение клиента можно было отразить в удаленном сеансе.
DisableDpiCursorScalingForProcess Отключает локальное масштабирование курсора мыши, полученного с сервера, обеспечивая правильную отрисовку фигуры курсора без изменений.
StartWorkspaceExtension Координирует удаленный сеанс клиента с помощью панели управления RemoteApp и подключения к рабочему столу.

Свойства

Класс MsRdpClient12 имеет следующие свойства.

Свойство Тип доступа Описание
AdvancedSettings
Только для чтения
Указатель интерфейса IMsTscAdvancedSettings .
AdvancedSettings2
Только для чтения
Указатель на интерфейс IMsRdpClientAdvancedSettings , используемый для задания дополнительных параметров для клиентского элемента управления.
AdvancedSettings3
Только для чтения
Указатель на интерфейс IMsRdpClientAdvancedSettings2 , используемый для задания дополнительных параметров для клиентского элемента управления.
AdvancedSettings4
Только для чтения
Указатель на интерфейс IMsRdpClientAdvancedSettings3 , используемый для задания дополнительных параметров для клиентского элемента управления.
AdvancedSettings5
Только для чтения
Указатель интерфейса IMsRdpClientAdvancedSettings4 .
AdvancedSettings6
Только для чтения
Интерфейс для IMsRdpClientAdvancedSettings5.
AdvancedSettings7
Только для чтения
Интерфейс для IMsRdpClientAdvancedSettings6.
AdvancedSettings8
Только для чтения
Объект , поддерживающий интерфейс IMsRdpClientAdvancedSettings7 .
AdvancedSettings9
Только для чтения
Интерфейс IMsRdpClientAdvancedSettings8 , представляющий объект settings.
AllowCredentialSaving
Чтение/запись
Указывает, отображается ли в диалоговом окне учетных данных поле проверка для включения сохранения учетных данных.
AllowPromptingForCredentials
Чтение/запись
Указывает, может ли элемент управления ActiveX удаленного рабочего стола запрашивать у пользователя учетные данные.
BinaryPassword
Чтение/запись
Данное свойство не поддерживается.
BinarySalt
Чтение/запись
Данное свойство не поддерживается.
CipherStrength
Только для чтения
Максимальная надежность шифрования текущего элемента управления.
ClearTextPassword
Только на запись
Пароль элемента управления ActiveX удаленного рабочего стола в формате открытого текста.
ColorDepth
Чтение/запись
Глубина цвета текущего элемента управления.
Подключен
Только для чтения
Состояние подключения текущего элемента управления.
ConnectedStatusText
Чтение/запись
Текст, отображаемый в клиентской области элемента управления, пока элемент управления находится в подключенном состоянии.
ConnectingText
Чтение/запись
Текст, отображаемый по центру элемента управления при соединении элемента управления.
ConnectionBarText
Чтение/запись
Текстовая строка, отображаемая для панели подключения.
DesktopHeight
Чтение/запись
Высота текущего элемента управления (в пикселях) на начальном удаленном рабочем столе.
DesktopWidth
Чтение/запись
Ширина текущего элемента управления (в пикселях) на начальном удаленном рабочем столе.
DeviceCollection
Только для чтения
Коллекция устройств PnP, доступных для перенаправления.
DisableConnectionBar
Только на запись
Указывает, должен ли элемент управления ActiveX удаленного рабочего стола отключать панель подключения.
DisableRemoteAppCapsCheck
Чтение/запись
Указывает, не должен ли элемент управления ActiveX удаленного рабочего стола проверка сервер для возможностей RemoteApp.
DisconnectedText
Чтение/запись
Текст, который отображается по центру в элементе управления перед завершением соединения.
Домен
Чтение/запись
Домен, в который входит текущий пользователь.
DriveCollection
Только для чтения
Коллекция дисков, доступных для перенаправления.
EnableCredSspSupport
Чтение/запись
Указывает, включен ли credSSP для этого подключения.
ExtendedDisconnectReason
Только для чтения
Дополнительные сведения о причине отключения клиентского элемента управления.
FullScreen
Чтение/запись
Указывает, находится ли элемент управления в полноэкранном режиме.
FullScreenTitle
Только на запись
Заголовок окна, отображаемый, когда элемент управления находится в полноэкранном режиме.
GetRemoteMonitorsBoundingBox
Только для чтения
Указывает ограничивающий прямоугольник удаленного монитора.
HorizontalScrollBarVisible
Только для чтения
Указывает, отображается ли в элементе управления горизонтальная полоса прокрутки.
LaunchedViaClientShellInterface
Чтение/запись
Указывает, запустил ли пользователь клиентский элемент управления с помощью интерфейса веб-доступа к удаленным рабочим столам.
MarkRdpSettingsSecure
Чтение/запись
Указывает, помечены ли параметры RDP как безопасные.
MsRdpClientShell
Только для чтения
Параметры клиента для средства запуска веб-портала.
NegotiateSecurityLayer
Чтение/запись
Указывает, поддерживается ли параметр NegotiateSecurityLayer для этого подключения.
Примечание: Если CredSspSupport включен и присутствует на клиенте или если включен протокол SSL с проверкой подлинности пользователя, NegotiateSecurityLayer игнорируется.
PortablePassword
Чтение/запись
Данное свойство не поддерживается.
PortableSalt
Чтение/запись
Данное свойство не поддерживается.
PromptForCredentials
Чтение/запись
Указывает, должно ли отображаться диалоговое окно запроса учетных данных.
PromptForCredsOnClient
Чтение/запись
Указывает, отображает ли клиентский элемент управления диалоговое окно с запросом учетных данных.
PublisherCertificateChain
Чтение/запись
Указывает цепочку сертификатов издателя. Цепочка хранится в варианте типа VT_BYREF, который содержит указатель на CERT_CHAIN_CONTEXT структуру.
RedirectDynamicDevices
Чтение/запись
Указывает, доступны ли динамически подключенные устройства PnP, перечисляемые во время сеанса, для перенаправления.
RedirectDynamicDrives
Чтение/запись
Указывает, доступны ли динамически подключенные диски PnP, перечисляемые во время сеанса, для перенаправления.
RedirectionWarningType
Чтение/запись
Управляет наличием и внешним видом диалогового окна перенаправления.
RemoteMonitorCount
Только для чтения
Указывает количество удаленных мониторов.
RemoteMonitorLayoutMatchesLocal
Только для чтения
Указывает, идентичен ли макет удаленного монитора макету локального монитора.
RemoteProgram
Только для чтения
Параметр remoteApp клиента.
RemoteProgram2
Только для чтения
Объект , поддерживающий интерфейс ITSRemoteProgram2 .
RemoteProgram3
Только для чтения
Объект , поддерживающий интерфейс ITSRemoteProgram3 .
SecuredSettings
Только для чтения
Указатель интерфейса IMsTscSecuredSettings .
SecuredSettings2
Только для чтения
Указатель на интерфейс IMsRdpClientSecuredSettings , используемый для задания защищенных параметров для клиентского элемента управления.
SecuredSettings3
Только для чтения
Объект , поддерживающий интерфейс IMsRdpClientSecuredSettings2 .
SecuredSettingsEnabled
Только для чтения
Указывает, доступен ли интерфейс IMsTscSecuredSettings .
Сервера
Чтение/запись
Имя сервера, к которому подключен текущий элемент управления.
ShowRedirectionWarningDialog
Чтение/запись
Указывает, должно ли отображаться диалоговое окно предупреждения системы безопасности перенаправления перед началом сеанса.
StartConnected
Чтение/запись
Указывает, установит ли элемент управления подключение к серверу узла сеансов удаленных рабочих стола сразу после запуска.
TransportSettings
Только для чтения
Параметр клиентского шлюза удаленных рабочих столов.
TransportSettings2
Только для чтения
Интерфейс для IMsRdpClientTransportSettings2.
TransportSettings3
Только для чтения
Объект , поддерживающий интерфейс IMsRdpClientTransportSettings3 .
TransportSettings4
Только для чтения
Объект , поддерживающий интерфейс IMsRdpClientTransportSettings4 .
TrustedZoneSite
Чтение/запись
Указывает, находится ли веб-сайт, с которого пользователь запустил подключение, в списке надежных сайтов клиентского компьютера.
UIParentWindowHandle
Чтение/запись
Дескриптор окна, который будет родительским окном для элемента управления. Это позволяет всем окнам, отображаемым элементом управления, быть правильно модальными по отношению к любым окнам, отображаемым родительским приложением.
UseMultimon
Чтение/запись
Указывает, должен ли элемент управления ActiveX удаленного рабочего стола использовать несколько мониторов.
UseRedirectionServerName
Чтение/запись
Указывает, следует ли использовать имя сервера перенаправления.
Пользователя
Чтение/запись
Учетные данные для входа в систему с именем пользователя.
Версия
Только для чтения
Номер версии текущего элемента управления.
VerticalScrollBarVisible
Только для чтения
Указывает, отображает ли элемент управления вертикальную полосу прокрутки.
WarnAboutClipboardRedirection
Чтение/запись
Указывает, должно ли диалоговое окно предупреждения системы безопасности включать предупреждение о перенаправлении буфера обмена перед началом сеанса.
WarnAboutDirectXRedirection
Чтение/запись
Это свойство не используется.
WarnAboutPrinterRedirection
Чтение/запись
Указывает, отображается ли в диалоговом окне перенаправления сообщение о перенаправлении принтера перед началом сеанса.
WarnAboutSendingCredentials
Чтение/запись
Указывает, должно ли предупреждение системы безопасности включать предупреждение об отправке учетных данных на удаленный сервер перед началом сеанса.
CameraRedirConfigCollection Только для чтения Возвращает коллекцию камер (и связанных конфигураций), доступных для перенаправления.
Буфер обмена Только для чтения Возвращает контроллер буфера обмена, используемый для синхронизации локальных и удаленных буферов обмена, если синхронизация буфера обмена включена вручную.
Correlationid Только для чтения Получает GUID, однозначно определяющий удаленный сеанс клиента.
SupportsWorkspaceReconnect Только на запись Информирует элемент управления ActiveX удаленного рабочего стола о том, что удаленный сеанс клиента является частью подключения на панели управления Подключения к удаленным рабочим столам RemoteApp, которая поддерживает повторное подключение.

Требования

Требование Значение
Минимальная версия клиента
Windows 10 [только классические приложения]
Минимальная версия сервера
Windows Server 2016
Библиотека типов
MsTscAx.dll
DLL
MsTscAx.dll
CLSID
CLSID_MsRdpClient12 определяется как 945EE98E-B376-4EC2-B2E5-64C9410F93B7

См. также раздел

Классы элементов ActiveX для удаленного рабочего стола