FFEffectStop(_:)

Declaration

func FFEffectStop(_ effectReference: FFEffectObjectReference!) -> HRESULT

Parameters

• effectReference:

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

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

FFERR_GENERIC

FFERR_INTERNAL

FFERR_INVALIDDOWNLOADID

See Also

Miscellaneous

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