IDirectPlayVoiceClient::SetClientConfig Method

Sets the client configuration.

Syntax

HRESULT SetClientConfig(      
    PDVCLIENTCONFIG pClientConfig
);

Parameters

pClientConfig

[in] Pointer to a DVCLIENTCONFIG structure that contains the configuration description to set.

Return Value

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

DVERR_INVALIDFLAGS	The flags passed to this method are invalid.
DVERR_INVALIDPARAM	One or more of the parameters passed to the method are invalid.
DVERR_INVALIDPOINTER	The pointer specified is invalid.
DVERR_NOTCONNECTED	The Microsoft® DirectPlay® Voice object is not connected.
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

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

Calling this method sets all the parameters in the DVCLIENTCONFIG structure. Therefore, to leave a setting unmodified, you must retrieve the current configuration with IDirectPlayVoiceClient::GetClientConfig. Then modify the parameters to change and call IDirectPlayVoiceClient::SetClientConfig.

If the session is running in half duplex mode, the members of the DVCLIENTCONFIG structure related to recording are ignored.