IDirectPlay8Server::EnumGroupMembers Method

Retrieves a list of all players in a group.

Syntax

HRESULT EnumGroupMembers(      

    const DPNID dpnid,
    DPNID *const prgdpnid,
    DWORD *const pcdpnid,
    const DWORD dwFlags
);

Parameters

dpnid

[in] Variable of type DPNID that specifies the group that contains the players to enumerate.

prgdpnid

[out] Pointer to an array that contains the identifiers of the group's players.

pcdpnid

[in, out] Pointer to a variable of type DWORD that contains the number of player identifiers in the prgdpnid parameter. If the buffer is too small, this method returns DPNERR_BUFFERTOOSMALL and this parameter is set to the number of entries that are required.

dwFlags

[in] Reserved. Must be 0.

Return Value

Returns S_OK if successful, or one of the following error values.

DPNERR_BUFFERTOOSMALL	The supplied buffer is not large enough to contain the requested data.
DPNERR_INVALIDFLAGS	The flags passed to this method are invalid.
DPNERR_INVALIDGROUP	The group ID is not recognized as a valid group ID for this game session.