Microsoft DirectX 8.1 (C++)

IDirectPlayVoiceServer::GetSessionDesc

Retrieves the Microsoft® DirectPlay® Voice session settings.

HRESULT GetSessionDesc(
PDVSESSIONDESC pvSessionDesc
);

Parameters

pvSessionDesc
[out] Pointer to a DVSESSIONDESC structure to receive the session description.

Return Values

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

DVERR_INVALIDOBJECT
DVERR_INVALIDPARAM
DVERR_INVALIDPOINTER
DVERR_NOTHOSTING
DVERR_NOTINITIALIZED
DVERR_SESSIONLOST

Remarks

Before calling this method, make sure to set the dwSize member of the DVSESSIONDESC structure.

A successful call to IDirectPlayVoiceServer::StartSession must be made before this method can be called.

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.