Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlayVoiceClient::GetClientConfig Method


Retrieves the client configuration.

Syntax

HRESULT GetClientConfig(      

    PDVCLIENTCONFIG pClientConfig );

Parameters

pClientConfig
[out] Pointer to a DVCLIENTCONFIG structure that contains the configuration of the local client.

Return Value

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

DVERR_INVALIDPARAMOne or more of the parameters passed to the method are invalid.
DVERR_INVALIDPOINTERThe pointer specified is invalid.
DVERR_NOTCONNECTEDThe Microsoft® DirectPlay® Voice object is not connected.
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.


Remarks

Before calling this method, you must set the DVCLIENTCONFIG structure's dwSize member.

You can call this method only after a connection is successfully established with a DirectPlay Voice session.



© 2003 Microsoft Corporation. All rights reserved.