PeerCollabInviteContact 函数 (p2p.h)
PeerCollabInviteContact 函数向受信任的联系人发送加入对等协作活动的邀请。 此调用是同步的,如果成功,将从联系人获取响应。
语法
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabInviteContact(
[in] PCPEER_CONTACT pcContact,
[in] PCPEER_ENDPOINT pcEndpoint,
[in] PCPEER_INVITATION pcInvitation,
[out] PPEER_INVITATION_RESPONSE *ppResponse
);
参数
[in] pcContact
指向包含与被邀请者关联的联系信息 的PEER_CONTACT 结构的指针。
[in] pcEndpoint
指向 PEER_ENDPOINT 结构的指针,该结构包含有关受邀对等方的信息。 调用此 API 时,会向此对等方发送邀请。
[in] pcInvitation
指向 PEER_INVITATION 结构的指针,该结构包含要发送到 pcEndpoint 中指定的终结点 () 的邀请请求。 此参数不得设置为 NULL。
[out] ppResponse
指向 PEER_INVITATION_RESPONSE 结构的指针,该结构接收受邀对等终结点对邀请请求的响应。
如果此调用失败并出现错误,则此参数将为 NULL。
释放通过调用 PeerFreeData 返回的内存。
返回值
如果函数成功,则返回S_OK。 否则,该函数返回以下值之一。
返回代码 | 说明 |
---|---|
|
内存不足,无法支持此操作。 |
|
其中一个参数无效。 |
|
邀请的收件人在 5 分钟内未答复。 |
注解
此 API 确保接收邀请的对等方是指定为输入的联系人。 如果指定的终结点上不存在特定联系人,则连接将失败。 建议使用 PeerCollabInviteContact 代替不太安全的 PeerCollabInviteEndpoint。
将为邀请的收件人显示一个 toast。 此 Toast 将转换为一个对话框,用户可以在其中接受或拒绝邀请。 成功接受邀请后,将在收件人的计算机上启动协作应用程序。
若要成功接收邀请,必须使用 PeerCollabRegisterApplication 在收件人的计算机上注册应用程序。 邀请的发件人也可能返回失败代码,因为收件人已关闭应用程序邀请。
如果收件人只接受来自受信任联系人的邀请,则必须将邀请的发件人添加到收件人计算机的联系人存储中。 在邀请尝试之前,必须将发件人添加到联系人存储中。 若要将联系人添加到联系人存储,请调用 PeerCollabAddContact。
邀请的收件人必须在 5 分钟内响应以避免超时。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | 无受支持的版本 |
目标平台 | Windows |
标头 | p2p.h |
Library | P2P.lib |
DLL | P2P.dll |