Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlayVoiceClient::GetSoundDeviceConfig Method


Retrieves the sound device configuration of the session.

Syntax

HRESULT GetSoundDeviceConfig(      

    PDVSOUNDDEVICECONFIG pSoundDeviceConfig,     PDWORD pdwSize );

Parameters

pSoundDeviceConfig
[out] Pointer to a DVSOUNDDEVICECONFIG structure that is filled with the configuration of the sound device.
pdwSize
[in, out] Pointer to a DWORD that specifies the size of the buffer in pSoundDeviceConfig parameter. If the buffer is too small, the method returns DVERR_BUFFERTOOSMALL and this parameter contains the size of the required buffer.

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

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



© 2003 Microsoft Corporation. All rights reserved.