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

[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 Values

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

Requirements

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