Microsoft DirectX 8.1 (C++)

IDirectPlayVoiceServer::StopSession

Stops the Microsoft® DirectPlay® Voice session.

HRESULT StopSession(
DWORD dwFlags
);

Parameters

dwFlags
[in] Flag. The following flag can be set.
DVFLAGS_NOHOSTMIGRATE
The host will not migrate regardless of session and transport settings. Use this flag when you want to shut down the voice session completely.

Return Values

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

DVERR_ALREADYPENDING
DVERR_INVALIDFLAGS
DVERR_INVALIDOBJECT
DVERR_INVALIDPARAM
DVERR_NOTHOSTING
DVERR_NOTINITIALIZED
DVERR_SESSIONLOST

Remarks

This method returns DVERR_ALREADYPENDING if it is called while another thread is processing a StopSession request.

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 Dvoice.h.