Platform SDK: DirectX

IDirectPlay4::DeletePlayerFromGroup

The IDirectPlay4::DeletePlayerFromGroup method 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_CONNECTIONLOST
DPERR_INVALIDGROUP
DPERR_INVALIDOBJECT
DPERR_INVALIDPLAYER

Remarks

A DPMSG_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.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dplay.h.
  Import Library: Use dplayx.lib.

See Also

IDirectPlay4::AddPlayerToGroup, DPMSG_DELETEPLAYERFROMGROUP