FFEffectEscape(_:_:)

Declaration

func FFEffectEscape(_ effectReference: FFEffectObjectReference!, _ pFFEffectEscape: UnsafeMutablePointer<FFEFFESCAPE>!) -> HRESULT

Parameters

• effectReference:

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

• pFFEffectEscape:

  FFEFFESCAPE structure that describes the command to be sent. On success, the cbOutBuffer member contains the number of bytes of the output buffer used.

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_UNSUPPORTED

Other device-specific error codes are also possible. Ask the hardware manufacturer for details

Discussion

Because each driver implements different escapes, it is the application’s responsibility to ensure that it is sending the escape to the correct driver.

See Also

Miscellaneous

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