IDirectSound3DListener::GetDistanceFactor

The IDirectSound3DListener::GetDistanceFactor method retrieves the current distance factor.

HRESULT GetDistanceFactor(
  LPD3DVALUE lpflDistanceFactor  
);
 

Parameters

lpflDistanceFactor

Address of a variable whose type is D3DVALUE and that will contain the current distance factor value.

Return Values

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be DSERR_INVALIDPARAM.

Remarks

For additional information about distance factors, see Distance Factor.

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dsound.h.
  Import Library: Use dsound.lib.

See Also

IDirectSound3DListener::SetDistanceFactor