IDirectInputEffect::GetEffectStatus Method

  • Article

Retrieves the status of an effect.

Syntax

HRESULT GetEffectStatus(
         LPDWORD pdwFlags
)

Parameters

  • pdwFlags
    Status flags for the effect. The value can be 0 or one or more of the following constants:
    • DIEGES_PLAYING
      The effect is playing.
    • DIEGES_EMULATED
      The effect is emulated.

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_INVALIDPARAM DIERR_NOTINITIALIZED

Requirements

Header: Declared in dinput.h.