FFEffectGetEffectStatus(_:_:)

Declaration

func FFEffectGetEffectStatus(_ effectReference: FFEffectObjectReference!, _ pFlags: UnsafeMutablePointer<FFEffectStatusFlag>!) -> HRESULT

Parameters

• effectReference:

  An opaque reference handle to an effect object. This is obtained from a previous call to FFDeviceCreateEffect.

• pFlags:

  Pointer to status flags for the effect. The value can be 0 or one or more of the following constants:

  FFEGES_PLAYING

  The effect is playing.

  FFEGES_EMULATED

  The effect is emulated.

Return Value

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

Discussion

FFERR_INVALIDPARAM

FFERR_NOTDOWNLOADED

See Also

Miscellaneous

• FFCreateDevice(_:_:)
• FFDeviceCreateEffect(_:_:_:_:)
• FFDeviceEscape(_:_:)
• FFDeviceGetForceFeedbackCapabilities(_:_:)
• FFDeviceGetForceFeedbackProperty(_:_:_:_:)
• FFDeviceGetForceFeedbackState(_:_:)
• FFDeviceReleaseEffect(_:_:)
• FFDeviceSendForceFeedbackCommand(_:_:)
• FFDeviceSetCooperativeLevel(_:_:_:)
• FFDeviceSetForceFeedbackProperty(_:_:_:)
• FFEffectDownload(_:)
• FFEffectEscape(_:_:)
• FFEffectGetParameters(_:_:_:)
• FFEffectSetParameters(_:_:_:)
• FFEffectStart(_:_:_:)