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 |