IDirectPlayVoiceServer::GetSessionDesc Method

Retrieves the Microsoft® DirectPlay® Voice session settings.

Syntax

HRESULT GetSessionDesc(      
    PDVSESSIONDESC pvSessionDesc
);

Parameters

pvSessionDesc

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

Return Value

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

DVERR_INVALIDOBJECT	The DirectPlay object pointer is invalid.
DVERR_INVALIDPARAM	One or more of the parameters passed to the method are invalid.
DVERR_INVALIDPOINTER	The pointer specified is invalid.
DVERR_NOTHOSTING	The object is not the host of the session.
DVERR_NOTINITIALIZED	The IDirectPlayVoiceClient::Initialize or IDirectPlayVoiceServer::Initialize method must be called before calling this method.
DVERR_SESSIONLOST	The transport has lost the connection to the session.

Remarks

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

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