peerCollabEnumApplications 函数 (p2p.h)

项目
08/25/2023

PeerCollabEnumApplications 函数返回枚举的句柄，该枚举包含注册到特定对等方终结点的应用程序 () 。

语法

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabEnumApplications(
  [in, optional] PCPEER_ENDPOINT pcEndpoint,
  [in, optional] const GUID      *pApplicationId,
  [out]          HPEERENUM       *phPeerEnum
);

parameters

[in, optional] pcEndpoint

指向 PEER_ENDPOINT 结构的指针，该结构包含将枚举其应用程序的对等方的终结点信息。

如果此参数设置为 NULL，则枚举本地对等终结点的已发布应用程序信息。

[in, optional] pApplicationId

指向 GUID 值的指针，该值唯一标识所提供的对等的特定应用程序。如果提供了此参数，则返回的唯一对等应用程序是与此 GUID 匹配的应用程序。

[out] phPeerEnum

指向与 pObjectId 中返回的 GUID 对应的已注册应用程序的枚举集句柄的指针。将此句柄传递给 PeerGetNextItem 以获取枚举集中的每个项。

返回值

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

返回代码	说明
E_OUTOFMEMORY	内存不足，无法支持此操作。
E_INVALIDARG	其中一个参数无效。
PEER_E_NOT_INITIALIZED	Windows 对等基础结构未初始化。需要调用相关的初始化函数。

注解

若要成功枚举指定终结点的应用程序，必须在终结点上提供应用程序数据。若要使应用程序数据可用，必须发生以下情况之一：

该终结点必须以前通过调用 PeerCollabEnumEndpoints 获取。
本地对等方必须通过调用 PeerCollabSubscribeEndpointData 订阅了终结点。
必须通过成功调用 PeerCollabRefreshEndpointData 来刷新终结点数据。

若要获取单个对等应用程序，请将返回的句柄传递给 PeerGetNextItem。若要关闭枚举并释放与其关联的资源，请将此句柄传递给 PeerEndEnumeration。枚举返回的各个项必须使用 PeerFreeData 释放。

对等应用程序数据项作为单个 PEER_APPLICATION 结构返回。

PeerCollabEnumApplications 函数为子网上不受信任联系人的终结点返回空数组。

要求


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

请参阅

peerCollabEnumApplications 函数 (p2p.h)

语法

parameters

返回值

注解

要求

请参阅

反馈

反馈

其他资源