Microsoft DirectX 9.0

IDirectPlay8Peer::RemovePlayerFromGroup Method

Removes a peer from a group.

When this method is called all peers connected to the application receive a DPN_MSGID_REMOVE_PLAYER_FROM_GROUP message.


HRESULT RemovePlayerFromGroup(      

    const DPNID idGroup,     const DPNID idClient,     PVOID const pvAsyncContext,     DPNHANDLE *const phAsyncHandle,     const DWORD dwFlags );


[in] Variable of type DPNID that specifies the identifier of the group that the peer will be removed from.
[in] Variable of type DPNID that specifies the identifier of the peer that will be removed from the group.
[in] Pointer to the user-supplied context, which is returned in the pvUserContext member of the DPN_MSGID_ASYNC_OP_COMPLETE system message.
[out] A DPNHANDLE. A value will be returned. However, Microsoft?DirectPlay?does not permit cancellation of this operation, so the value cannot be used.
[in] Flag that controls how this method is processed. The following flag can be set for this method.
Causes the method to process synchronously.

Return Value

Returns S_OK if this method is processed synchronously and is successful. By default, this method is run asynchronously and normally returns DPNSUCCESS_PENDING. It can also return one of the following error values.

DPNERR_INVALIDFLAGSThe flags passed to this method are invalid.
DPNERR_INVALIDGROUPThe group ID is not recognized as a valid group ID for this game session.
DPNERR_INVALIDPLAYERThe player ID is not recognized as a valid player ID for this game session.
DPNERR_PLAYERNOTINGROUPThe player ID is not included in the group.

© 2002 Microsoft Corporation. All rights reserved.