Microsoft DirectX 8.0 (C++)

IDirectPlay8Server::DestroyClient

Deletes a client from the session.

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

Parameters

dpnidClient
Variable of type DPNID that specifies the identifier of the client to delete.
pDestroyInfo
Pointer that describes additional delete data information.
dwDestroyInfoSize
Variable of type DWORD that specifies the size of the data in the pDestroyInfo parameter.
dwFlags
Reserved. Must be 0.

Return Values

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

DPNERR_INVALIDPARAM
DPNERR_INVALIDPLAYER
DPNERR_NOTHOST

Requirements

  Windows NT/2000: Available as a redistributable for Windows 2000 and later.
  Windows 95/98: Available as a redistributable for Windows 95 and later.
  Header: Declared in Dplay8.h.