Microsoft DirectX 8.1 (C++)

IDirectPlay8Peer::TerminateSession

Terminates the current Microsoft® DirectPlay® session.

HRESULT TerminateSession(
void *const pvTerminateData,
const DWORD dwTerminateDataSize,
const DWORD dwFlags
);

Parameters

pvTerminateData
[in] Pointer to termination data. This data is also sent in the pvTerminateData member of the DPN_MSGID_TERMINATE_SESSION system message.
dwTerminateDataSize
[in] Size of data contained in the pvTerminateData parameter.
dwFlags
[in] Reserved. Must be 0.

Remarks

This method may be called only by the host player.

When this method is called, the DPN_MSGID_TERMINATE_SESSION will be sent to the message handler of each player in the session.

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.