DirectPlay8Peer.AddPlayerToGroup

Adds a peer to a group.

When this method is called, DirectPlay calls each player's DirectPlay8Event.AddRemovePlayerGroup method to notify him or her of the new group member.

AddPlayerToGroup(idGroup As Long, _
    idClient As Long, 
    lFlags As Long) As Long

Parts

idGroup

Long value that specifies the identifier of the group to add the peer to.

idClient

Long value that specifies the identifier of the peer that is added to the group.

lFlags

Flag that controls how this method is processed. The following flag can be set for this method.

DPNOP_SYNC

Causes the method to process synchronously.

Return Values

Returns the asynchronous handle for this operation. This is the handle that is used in lAsyncHandle parameter of the DirectPlay8Peer.CancelAsyncOperation method to cancel the request, if the request is processed asynchronously.

Error Codes

If the method fails, Err.Number can be set to one of the following values.

Remarks

Any peer can add itself or another peer to an existing group. After the peer is successfully added to the group, all messages sent to the group are also sent to the peer.

For a peer to add itself to the group, pass DPNID_ME in the idClient parameter.