##

IDirectPlay3::DestroyPlayer

IDirectPlay3 Interface

Deletes a local player from the session, removes any pending messages destined for that player from the message queue, and removes the player from any groups to which it belonged. The player ID will not be reused during the current session.

HRESULT DestroyPlayer(
DPID idPlayer
);

##### Parameters

idPlayer
  Player ID of the player that is being removed from the session.

##### Return Values

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

DPERR_ACCESSDENIED
DPERR_INVALIDOBJECT
DPERR_INVALIDPLAYER

##### Remarks

This method will generate a DPMSG_DELETEPLAYERFROMGROUP system message for each group that the player belongs to, and then a DPMSG_DESTROYPLAYERORGROUP system message.

Only the application that created the player can destroy it.

##### See Also

IDirectPlay3::CreatePlayer, DPMSG_DESTROYPLAYERORGROUP

© 1997 Microsoft Corporation. All rights reserved. Terms of Use.