FFDeviceGetForceFeedbackProperty(_:_:_:_:)

Declaration

func FFDeviceGetForceFeedbackProperty(_ deviceReference: FFDeviceObjectReference!, _ property: FFProperty, _ pValue: UnsafeMutableRawPointer!, _ valueSize: IOByteCount) -> HRESULT

Parameters

• deviceReference:

  An opaque reference handle to the device object that is be disposed of. This handle is obtained from a previous call to FFCreateDevice.

• property:

  The following property values are defined for a FF device (see FFDeviceSetForceFeedbackProperty for details):

  FFPROP_AUTOCENTER

  FFPROP_FFGAIN

• pValue:

  Address of the location where the value associated with the property is to be stored. GetForceFeedbackProperty assumes that the pointer is valid, although it will perform a size check before writing the data to pValue

• valueSize:

  Size, in bytes, of data area pointed to by pValue. Size is compared to expected property size, and the function fails if a mismatch occurs.

Return Value

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

Discussion

FFERR_INVALIDPARAM

See Also

Miscellaneous

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