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。 否則,函式會傳回下列其中一個值。
傳回碼 | Description |
---|---|
|
記憶體不足,無法支援這項作業。 |
|
其中一個自變數無效。 |
|
Windows 對等基礎結構未初始化。 需要呼叫相關的初始化函式。 |
|
此作業需要使用者登入。 |
備註
對等物件是與特定應用程式相關聯的運行時間數據項,例如圖片、虛擬人偶、憑證或特定描述。 每個對等物件的大小必須小於 16K。
PeerCollabEnumObjects 會傳回針對本機對等發行的所有物件。 物件可以由多個應用程式發佈。
若要取得個別對等物件,請將傳回的句柄傳遞至 PeerGetNextItem。 對等物件會以指標陣列的形式傳回 給PEER_OBJECT 結構。 如果端點未發佈任何物件,則會傳回空陣列。 若要關閉列舉並釋放與其相關聯的資源,請將此句柄傳遞至 PeerEndEnumeration。 列舉傳回的個別項目必須使用 PeerFreeData 釋放。
若要成功取得對等物件:
- 先前必須藉由呼叫 PeerCollabEnumEndpoints 來取得端點。
- 本機對等必須藉由呼叫 PeerCollabSubscribeEndpointData 來訂閱端點。
- 端點數據必須藉由成功呼叫 PeerCollabRefreshEndpointData 來重新整理。
如果使用者正在發佈圖片,可以藉由擷取對應的物件來取得圖片。 圖片物件的 GUID 是PEER_COLLAB_OBJECTID_USER_PICTURE。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | 都不支援 |
目標平台 | Windows |
標頭 | p2p.h |
程式庫 | P2P.lib |
Dll | P2P.dll |