IDirectSound3DBuffer::GetMinDistance

The IDirectSound3DBuffer::GetMinDistance method retrieves the current minimum distance for this sound buffer.

HRESULT GetMinDistance(
  LPD3DVALUE lpflMinDistance  
);
 

Parameters

lpflMinDistance

Address of a variable that will contain the current minimum distance setting.

Return Values

If the method succeeds, the return value is DS_OK.

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

Remarks

By default, the minimum distance value is DS3D_DEFAULTMINDISTANCE, currently defined as 1.0 (corresponding to 1.0 meter at the default distance factor of 1.0 m per unit).

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in dsound.h.
  Import Library: Use dsound.lib.

See Also

IDirectSound3DBuffer::SetMinDistance, IDirectSound3DBuffer::GetMaxDistance