PeerGraphEnumRecords 函数 (p2p.h)
PeerGraphEnumRecords 函数创建并返回枚举句柄,该句柄用于枚举特定类型的记录和/或用户。 枚举在执行枚举时提供记录快照。
语法
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerGraphEnumRecords(
[in] HGRAPH hGraph,
[in] const GUID *pRecordType,
[in] PCWSTR pwzPeerId,
[out] HPEERENUM *phPeerEnum
);
参数
[in] hGraph
对等图的句柄。
[in] pRecordType
指向要枚举的记录类型的指针。 指定 NULL 以枚举所有记录类型。
[in] pwzPeerId
指向一个字符串的指针,该字符串标识应用程序正在为其请求枚举的创建者。 指定 NULL 以枚举所有记录。
[out] phPeerEnum
接收枚举的句柄。 为 PeerGraphGetNextItem 的所有调用提供句柄。 当不需要句柄时,通过调用 PeerGraphEndEnumeration 来释放它。
返回值
如果函数调用成功,则返回值 S_OK。 否则,它将返回以下值之一。
返回代码 | 说明 |
---|---|
|
一个参数无效。 |
|
没有足够的内存来执行指定的操作。 |
|
对等图的句柄无效。 |
|
必须先通过调用 PeerGraphStartup 初始化图形,然后才能使用此函数。 |
注解
- 如果 pRecordType 和 pwzPeerId 参数均为 NULL,则返回所有记录。
- 对于简单的枚举任务,请使用 PeerGraphEnumRecords 函数,因为它比 PeerGraphSearchRecords 函数更高效。 对于复杂的枚举和筛选任务(例如数据库的启发式搜索),请使用 PeerGraphSearchRecords 函数。
- 使用 PeerGraphEnumRecords 返回的句柄调用 PeerGraphGetNextItem 时,PeerGraphGetNextItem 返回PEER_RECORD结构中的数据。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | 具有 SP2 的 Windows XP [仅限桌面应用],具有 SP1 的 Windows XP 与高级网络包 forWindows XP |
最低受支持的服务器 | 无受支持的版本 |
目标平台 | Windows |
标头 | p2p.h |
Library | P2PGraph.lib |
DLL | P2PGraph.dll |