Microsoft DirectX 9.0

IDirectSoundCaptureFXNoiseSuppress8::Reset

The IDirectSoundCaptureFXNoiseSuppress8::Reset method resets the effect to its initial state.

Syntax

HRESULT Reset();

Parameters

None.

Return Values

If the method succeeds, the return value is DS_OK.

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

Remarks

Applications should not reset an effect except when necessary because it has entered an incorrect state. This might be done in response to user input. An effect must not be reset arbitrarily at startup, because another application might be using the same effect.

Requirements

  Header: Declared in dsound.h.

  Operating System: Requires Microsoft Windows XP or later.

See Also