PeerCollabEnumObjects 函数 (p2p.h)
PeerCollabEnumObjects 函数将句柄返回到包含与特定对等终结点关联的对等对象的枚举。
语法
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabEnumObjects(
[in] PCPEER_ENDPOINT pcEndpoint,
[in, optional] const GUID *pObjectId,
[out] HPEERENUM *phPeerEnum
);
参数
[in] pcEndpoint
指向包含要枚举其对象的对等方的终结点信息的 PEER_ENDPOINT 结构的指针。
如果此参数为 NULL ，则返回本地对等联系人的已发布对象。
[in, optional] pObjectId
指向唯一标识具有提供的对等对象的 GUID 值的指针。 如果提供了此参数，则返回的唯一对等对象是与此 GUID 匹配的对象。
[out] phPeerEnum
指向与 pObjectId 中返回的 GUID 对应的枚举对等对象的句柄的指针。 将此句柄传递给 PeerGetNextItem ，以获取枚举集中的每个项。
返回值
如果函数成功，则返回S_OK。 否则，该函数返回以下值之一。
| 返回代码 | 说明 |
|---|---|
|
没有足够的内存来支持此操作。 |
|
其中一个参数无效。 |
|
未初始化 Windows 对等基础结构。 需要调用相关的初始化函数。 |
|
该操作要求用户登录。 |
注解
对等对象是与特定应用程序关联的运行时数据项，例如图片、头像、证书或特定说明。 每个对等对象的大小必须小于 16K。
PeerCollabEnumObjects 将返回为本地对等方发布的所有对象。 对象可由多个应用程序发布。
若要获取单个对等对象，请将返回的句柄传递给 PeerGetNextItem。 对等对象作为指向 PEER_OBJECT 结构的指针数组返回。 如果终结点未发布任何对象，将返回空数组。 若要关闭枚举并释放与之关联的资源，请将此句柄传递给 PeerEndEnumeration。 枚举返回的各个项必须使用 PeerFreeData 释放。
成功获取对等对象：
- 必须先通过调用 PeerCollabEnumEndpoints 来获取终结点。
- 本地对等方必须通过调用 PeerCollabSubscribeEndpointData 来订阅终结点。
- 必须通过成功调用 PeerCollabRefreshEndpointData 来刷新终结点数据。
如果用户正在发布图片，可以通过检索相应的对象来获取图片。 图片对象的 GUID PEER_COLLAB_OBJECTID_USER_PICTURE。
要求
| 最低受支持的客户端 | Windows Vista [仅限桌面应用] |
| 最低受支持的服务器 | 无受支持的版本 |
| 目标平台 | Windows |
| 标头 | p2p.h |
| Library | P2P.lib |
| DLL | P2P.dll |