Microsoft DirectX 9.0

IDirectPlayVoiceServer::GetSessionDesc Method

Retrieves the Microsoft?DirectPlay?Voice session settings.


HRESULT GetSessionDesc(      

    PDVSESSIONDESC 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_INVALIDOBJECTThe DirectPlay object pointer is invalid.
DVERR_INVALIDPARAMOne or more of the parameters passed to the method are invalid.
DVERR_INVALIDPOINTERThe pointer specified is invalid.
DVERR_NOTHOSTINGThe object is not the host of the session.
DVERR_NOTINITIALIZEDThe IDirectPlayVoiceClient::Initialize or IDirectPlayVoiceServer::Initialize method must be called before calling this method.
DVERR_SESSIONLOSTThe transport has lost the connection to the session.


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.

© 2002 Microsoft Corporation. All rights reserved.