IRDPSRAPIViewer::Connect 方法 (rdpencomapi.h)

[自 Windows 10 版本 1709 起,IRDPSRAPIViewer 接口不再可用于 UWP 应用程序。 桌面应用仍支持它。]

启动与共享者的实际连接。

语法

HRESULT Connect(
  [in] BSTR bstrConnectionString,
  [in] BSTR bstrName,
  [in] BSTR bstrPassword
);

参数

[in] bstrConnectionString

类型: BSTR

用于连接到共享者和对查看器进行身份验证的连接字符串。

[in] bstrName

类型: BSTR

查看器的名称。 该名称将发送给共享者和其他查看者。 字符串限制为 255 个字符。

[in] bstrPassword

类型: BSTR

用于身份验证的密码。 密码从共享者带外发送。

返回值

类型: HRESULT

如果方法成功,则返回值 S_OK。 否则,返回值为错误代码。

注解

bstrConnectionString 参数中包含的连接字符串由共享者生成,查看器通过完成以下步骤获取:

  1. 共享者从 IRDPSRAPISharingSession::Invitations 属性获取 IRDPSRAPIInvitationManager 接口的实例。
  2. 共享者通过调用 IRDPSRAPIInvitationManager::CreateInvitation 方法获取 IRDPSRAPIInvitation 接口的实例。
  3. 共享者从 IRDPSRAPIInvitation::ConnectionString 属性获取连接字符串。
  4. 共享者使用应用程序定义的方法将连接字符串发送到查看器,例如将连接字符串存储在文件中并与查看器共享文件。
为了提高安全性,应用程序可以将密码与共享方上的邀请相关联。 此类密码通常通过用于发送连接字符串以外的某种机制分发给查看者。 这是为了防止网络“嗅探”类型的攻击。 如果邀请具有与之关联的密码,则必须通过此 API 传入密码。 否则,与会者将断开连接。

在此属性中设置的 bstrName 字符串在连接启动后发送到共享者。 属性是共享应用程序可以选择显示的友好名称。 当邀请用于对多个与会者进行身份验证时,属性非常有用,因为它允许共享者和其他查看者识别谁正在参与 Windows 桌面共享会话。

要求

要求
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 rdpencomapi.h
DLL RdpEncom.dll

另请参阅

IRDPSRAPIViewer