IDirectPlay3::DeletePlayerFromGroup

Removes a player from a group.

HRESULT DeletePlayerFromGroup(
DPID idGroup,
DPID idPlayer
);

Parameters

idGroup

Group ID of the group to be adjusted.

idPlayer

Player ID of the player to be removed from the group.

Return Values

Returns DP_OK if successful, or one of the following error messages otherwise:

DPERR_INVALIDGROUP

DPERR_INVALIDOBJECT

DPERR_INVALIDPLAYER

Remarks

A DPSYS_DELETEPLAYERFROMGROUP system message is generated to inform the other players of this change. For a list of system messages, see Using System Messages.

A player can delete any player from a group, even if that group was created by some other computer.

See Also

IDirectPlay3::AddPlayerToGroup, DPMSG_DELETEPLAYERFROMGROUP