PeerGroupEnumMembers 函式 (p2p.h)
PeerGroupEnumMembers 函式會建立可用對等群組成員和相關聯成員資格資訊的列舉。
語法
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerGroupEnumMembers(
[in] HGROUP hGroup,
[in] DWORD dwFlags,
[in] PCWSTR pwzIdentity,
[out] HPEERENUM *phPeerEnum
);
參數
[in] hGroup
處理要列舉其成員的對等群組。 PeerGroupCreate、PeerGroupOpen 或 PeerGroupJoin 函式會傳回此句柄。 此為必要參數。
[in] dwFlags
指定 PEER_MEMBER_FLAGS 旗標,指出要包含在列舉中的成員類型。 如果此值設定為零,則會包含對等群組的所有成員。
值 | 意義 |
---|---|
|
列舉目前對等群組的所有成員,這些成員都在在線。 |
[in] pwzIdentity
Unicode 字串,其中包含擷取資訊並在一個專案列舉中傳回的特定對等識別。 如果此參數為 NULL,則會擷取目前對等群組的所有成員。 此為必要參數。
[out] phPeerEnum
列舉的指標,其中包含對等群組成員的傳回清單。 此句柄會傳遞至
PeerGetNextItem 以擷取專案,每個項目都會以 PEER_MEMBER 結構的指標表示。 完成時, 會呼叫PeerEndEnumeration 來傳回列舉所使用的記憶體。 此為必要參數。
傳回值
如果作業成功,則傳回S_OK。 否則,函式會傳回下列其中一個值。
傳回碼 | Description |
---|---|
|
其中一個參數無效。 |
|
記憶體不足,無法執行指定的作業。 |
|
對等群組的句柄無效。 |
密碼編譯特定錯誤可以從 Microsoft RSA 基底提供者傳回。 這些錯誤前面會加上 CRYPT_* ,並在 Winerror.h 中定義。
備註
如果 pwzIdentity 為 NULL,則本機節點一律是列舉中的第一個專案,而且 dwFlags 設定為表示本機節點是明確子集的成員。
根據預設,每個成員都會將成員資格資訊發佈至對等群組。 如果在該對等PEER_MEMBER數據上設定PEER_MEMBER_DATA_OPTIONAL,只有在對等執行群組內的動作時,才可使用這項資訊,例如,發佈記錄、更新存在狀態或發出 GMC。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP 搭配 SP2 [僅限傳統型應用程式],Windows XP 搭配 SP1 與適用於Windows XP 的進階網络套件 |
最低支援的伺服器 | 都不支援 |
目標平台 | Windows |
標頭 | p2p.h |
程式庫 | P2P.lib |
Dll | P2P.dll |