Platform SDK: DirectX

DirectPlay4.DeletePlayerFromGroup

The DirectPlay4.DeletePlayerFromGroup method removes a player from a group.

object.DeletePlayerFromGroup(GroupId As Long, _
    playerId As Long) 

Parameters

object
Object expression that resolves to a DirectPlay4 object.
GroupId
ID of the group from which the player is to be removed.
playerId
ID of the player to be removed from the group.

Error Codes

If the method fails, an error is raised and Err.Number may be set to one of the following values:

DPERR_CONNECTIONLOST
DPERR_INVALIDGROUP
DPERR_INVALIDOBJECT
DPERR_INVALIDPLAYER

Remarks

A DPSYS_DELETEPLAYERFROMGROUP system message is generated to inform the other players of this change.

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

See Also

DirectPlay4.AddPlayerToGroup