Microsoft DirectX 8.1 (Visual Basic)

DirectPlay8Server.DestroyClient

Deletes a client from the session.

DestroyClient(idClient As Long, _
    lFlags As Long, _
    UserData As Any, _
    UserDataSize As Long)

Parts

idClient
Long value that specifies the identifier of the client to delete.
lFlags
Reserved. Must be 0.
UserData
Application-specific user data.
UserDataSize
Long value that specifies the size of the data contained in the UserData parameter.

Error Codes

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

DPNERR_NOTHOST
DPNERR_INVALIDPLAYER
DPNERR_INVALIDPARAM

Remarks

This method calls the DirectPlay8Event.DestroyPlayer method in the destroyed player's message handler.