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 设置为 允许 的终结点才可用。 联系人还必须登录到 Internet。 如果联系人未登录,将返回 错误E_INVALIDARG

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

与单个联系人的连接限制为 50。

要求

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

另请参阅

PEER_ENDPOINT

对等协作 API 函数