IDirectSoundCaptureBuffer8::GetFXStatus

The GetFXStatus method retrieves the status of capture effects.

Syntax

HRESULT GetFXStatus(
  DWORD dwFXCount, 
  LPDWORD pdwFXStatus
);

Parameters

dwFXCount

Number of elements in the pdwFXStatus array.

pdwFXStatus

Address of an array of DWORD variables that receive the status of each effect. This should contain the same number of elements as the array passed in the dwFXCount member of the DSCBUFFERDESC structure passed to DirectSoundFullDuplexCreate8 or IDirectSoundCapture8::CreateCaptureBuffer. The possible values returned in the array are as follows:

Return Values

If the method succeeds, the return value is DS_OK.

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

Requirements

  Header: Declared in dsound.h.

See Also

• IDirectSoundCaptureBuffer8 Interface
• Capture Buffer Effects