IDirectInputEffect::Stop Method

Stops playing an effect.

Syntax

HRESULT Stop()

Return Value

If the method succeeds, the return value is DI_OK. If the method fails, the return value can be one of the following error values: DIERR_NOTEXCLUSIVEACQUIRED, DIERR_NOTINITIALIZED.

Remarks

The device must be acquired at the exclusive cooperative level for this method to succeed.

Requirements

Header: Declared in dinput.h.