peerCollabInviteEndpoint 函数 (p2p.h)

PeerCollabInviteEndpoint 函数向指定的对等终结点发送邀请,以加入发件人的对等协作活动。 此调用是同步的,如果成功,则从对等终结点获取响应。

语法

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabInviteEndpoint(
  [in]  PCPEER_ENDPOINT           pcEndpoint,
  [in]  PCPEER_INVITATION         pcInvitation,
  [out] PPEER_INVITATION_RESPONSE *ppResponse
);

参数

[in] pcEndpoint

指向 PEER_ENDPOINT 结构的指针,该结构包含有关受邀对等方的信息。 调用此 API 时,会向此对等方发送邀请。

此参数不得设置为 NULL

[in] pcInvitation

指向 PEER_INVITATION 结构的指针,该结构包含要发送到 pcEndpoint 中指定的终结点的邀请请求。 此参数不得设置为 NULL

[out] ppResponse

指向 PEER_INVITATION_RESPONSE 结构的指针,该结构接收受邀对等终结点对邀请请求的响应。

如果此调用失败并出现错误,则输出时此参数将为 NULL

释放与此结构关联的内存,方法是将其传递给 PeerFreeData

返回值

如果函数成功,则返回S_OK。 否则,该函数返回以下值之一。

返回代码 说明
E_OUTOFMEMORY
内存不足,无法支持此操作。
E_INVALIDARG
其中一个参数无效。
PEER_E_TIMEOUT
邀请的收件人在 5 分钟内未答复。

注解

此 API 向指定为输入的终结点发送邀请。 它不保证邀请的接收者是用户打算向其发送邀请的特定联系人。 若要确保将邀请发送给正确的联系人,请调用 PeerCollabInviteContact

将为邀请的收件人显示一个 toast。 此 Toast 将转换为一个对话框,用户可以在其中接受或拒绝邀请。 成功接受邀请后,将在收件人的计算机上启动协作应用程序。

若要成功接收邀请,必须使用 PeerCollabRegisterApplication 在收件人的计算机上注册应用程序。 邀请的发件人也可能返回失败代码,因为收件人已关闭应用程序邀请。

邀请的收件人必须在 5 分钟内响应以避免超时。

要求

要求
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 无受支持的版本
目标平台 Windows
标头 p2p.h
Library P2P.lib
DLL P2P.dll

另请参阅

PEER_ENDPOINT

PEER_INVITATION

PEER_INVITATION_RESPONSE

对等协作 API 函数

PeerCollabGetAppLaunchInfo