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。 否則,它會傳回下列其中一個值。
傳回碼 | Description |
---|---|
|
一個參數無效。 |
|
記憶體不足,無法執行指定的作業。 |
|
對等圖形的句柄無效。 |
|
使用這個函式之前,必須先使用 對PeerGraphStartup 的呼叫來初始化圖形。 |
備註
- 如果 pRecordType 和 pwzPeerId 參數都是 NULL,則會傳回所有記錄。
- 針對簡單的列舉工作,請使用 PeerGraphEnumRecords 函式,因為它比 PeerGraphSearchRecords函 式更有效率。 如需複雜的列舉和篩選工作,例如資料庫的啟發式搜尋,請使用 PeerGraphSearchRecords函 式。
- 使用 PeerGraphEnumRecords 傳回的句柄呼叫 PeerGraphGetNextItem 時,PeerGraphGetNextItem 會傳回PEER_RECORD結構中的數據。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP 搭配 SP2 [僅限傳統型應用程式],Windows XP 含 SP1 與 Windows XP 的進階網络套件 |
最低支援的伺服器 | 都不支援 |
目標平台 | Windows |
標頭 | p2p.h |
程式庫 | P2PGraph.lib |
Dll | P2PGraph.dll |