IDirectPlay8Server::DestroyClient Method

Deletes a client from the session.

Syntax

HRESULT DestroyClient(      
    const DPNID dpnidClient,
    const VOID *const pDestroyInfo,
    const DWORD dwDestroyInfoSize,
    const DWORD dwFlags
);

Parameters

dpnidClient

[in] Variable of type DPNID that specifies the identifier of the client to delete.

pDestroyInfo

[in] Pointer that describes additional delete data information.

dwDestroyInfoSize

[in] Variable of type DWORD that specifies the size of the data in the pDestroyInfo parameter.

dwFlags

[in] Reserved. Must be 0.

Return Value

Returns S_OK if successful, or one of the following error values.

DPNERR_INVALIDPARAM	One or more of the parameters passed to the method are invalid.
DPNERR_INVALIDPLAYER	The player ID is not recognized as a valid player ID for this game session.
DPNERR_NOTHOST	The client attempted to connect to a nonhost computer. Additionally, this error value may be returned by a nonhost that tried to set the application description.