PeerGroupEnumMembers function

The PeerGroupEnumMembers function creates an enumeration of available peer group members and the associated membership information.

Syntax


HRESULT WINAPI PeerGroupEnumMembers(
  _In_  HGROUP    hGroup,
  _In_  DWORD     dwFlags,
  _In_  PCWSTR    pwzIdentity,
  _Out_ HPEERENUM *phPeerEnum
);

Parameters

hGroup [in]

Handle to the peer group whose members are enumerated. This handle is returned by the PeerGroupCreate, PeerGroupOpen, or PeerGroupJoin function. This parameter is required.

dwFlags [in]

Specifies the PEER_MEMBER_FLAGS flags that indicate which types of members to include in the enumeration. If this value is set to zero, all members of the peer group are included.

ValueMeaning
PEER_MEMBER_PRESENT

Enumerate all members of the current peer group that are online.

 

pwzIdentity [in]

Unicode string that contains the identity of a specific peer whose information is retrieved and returned in a one-item enumeration. If this parameter is NULL, all members of the current peer group are retrieved. This parameter is required.

phPeerEnum [out]

Pointer to the enumeration that contains the returned list of peer group members. This handle is passed to PeerGetNextItem to retrieve the items, with each item represented as a pointer to a PEER_MEMBER structure. When finished, PeerEndEnumeration is called to return the memory used by the enumeration. This parameter is required.

Return value

Returns S_OK if the operation succeeds. Otherwise, the function returns one of the following values.

Return codeDescription
E_INVALIDARG

One of the parameters is not valid.

E_OUTOFMEMORY

There is not enough memory to perform the specified operation.

PEER_E_INVALID_GROUP

The handle to the peer group is invalid.

 

Cryptography-specific errors can be returned from the Microsoft RSA Base Provider. These errors are prefixed with CRYPT_* and defined in Winerror.h.

Remarks

The local node is always the very first item in the enumeration if pwzIdentity is NULL, and dwFlags is set to indicate that the local node is a member of the explicit subset.

By default, every member publishes membership information to the peer group. If PEER_MEMBER_DATA_OPTIONAL is set on the PEER_MEMBER data for that peer, this information is only available when a peer performs an action within the group, for example, publishing a record, updating presence, or issuing a GMC.

Requirements

Minimum supported client

Windows XP with SP2 [desktop apps only]

Minimum supported server

None supported

Version

Windows XP with SP1 with the Advanced Networking Pack forWindows XP

Header

P2P.h

Library

P2P.lib

DLL

P2P.dll

See also

PeerEndEnumeration
PeerGetItemCount
PeerGetNextItem

 

 

Community Additions

ADD
Show: