PeerCollabEnumEndpoints 函数 (p2p.h)

  • 项目

PeerCollabEnumEndpoints 函数返回枚举的句柄，该枚举包含与特定对等联系人关联的终结点。

语法

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabEnumEndpoints(
  [in]  PCPEER_CONTACT pcContact,
  [out] HPEERENUM      *phPeerEnum
);

参数

[in] pcContact

指向包含特定对等方的联系人信息的 PEER_CONTACT 结构的指针。 此参数不得为 NULL。

[out] phPeerEnum

指向与提供的对等联系人关联的一组枚举终结点的句柄的指针。 将此句柄传递给 PeerGetNextItem 以获取枚举集中的每个项。

返回值

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

返回代码 说明
E_OUTOFMEMORY
 没有足够的内存来支持此操作。
E_INVALIDARG
 其中一个参数无效。
PEER_E_NOT_INITIALIZED
 Windows 对等基础结构未初始化。 需要调用相关的初始化函数。
PEER_E_NOT_SIGNED_IN
 该操作要求用户登录。

注解

建议在调用 PeerCollabEnumEndpoints 之前使用 PeerCollabUpdateContact 更新联系人记录。 否则可能导致返回E_INVALIDARG。

终结点仅适用于 fWatch 设置为 true 的联系人。 只有具有呼叫对等方的“Me”联系人保存为受信任联系人并将 WatcherPermissions 设置为 allow 的终结点才可用。 联系人还必须登录到 Internet。 如果联系人未登录，将返回错误 E_INVALIDARG 。

若要获取单个对等终结点，请将返回的句柄传递给 PeerGetNextItem。 将返回指向 PEER_ENDPOINT 结构的指针数组。 如果没有可用的终结点，将返回空数组。 若要关闭枚举并释放与之关联的资源，请将此句柄传递给 PeerEndEnumeration。 枚举返回的各个项必须使用 PeerFreeData 释放。

与单个触点的连接限制为 50。

要求

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

另请参阅

PEER_ENDPOINT

对等协作 API 函数