Function

FFDeviceGetForceFeedbackProperty

Gets properties that define the device behavior.

Declaration

HRESULT FFDeviceGetForceFeedbackProperty(FFDeviceObjectReference deviceReference, FFProperty property, void *pValue, IOByteCount valueSize);

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:

FFERR_INVALIDPARAM

See Also

Miscellaneous

FFCreateDevice

Creates a new API device object from an OS object in preparation to use the device for force feedback.

FFDeviceCreateEffect

Creates and initializes an instance of an effect identified by the effect UUID on the device.

FFDeviceEscape

Sends a hardware-specific command to the device.

FFDeviceGetForceFeedbackCapabilities

Retrieves the device's force feedback capabilities.

FFDeviceGetForceFeedbackState

Retrieves the state of the device's force feedback system.

FFDeviceReleaseEffect

Disposes of an API effect object created with FFDeviceCreateEffect.

FFDeviceSendForceFeedbackCommand

Sends a command to the device's force feedback system.

FFDeviceSetCooperativeLevel

Function is unimplemented in version 1.0 of this API

FFDeviceSetForceFeedbackProperty

Retrieves the device's force feedback capabilities.

FFEffectDownload

Places the effect on the device. If the effect is already on the device, the existing effect is updated to match the values set by the FFEffectSetParameters method.

FFEffectEscape

Sends a hardware-specific command to the driver.

FFEffectGetEffectStatus

Sends a hardware-specific command to the driver.

FFEffectGetParameters

Retrieves information about an effect.

FFEffectSetParameters

Sets the characteristics of an effect.

FFEffectStart

Begins playing an effect. If the effect is already playing, it is restarted from the beginning. If the effect has not been downloaded or has been modified since its last download, it is downloaded before being started. This default behavior can be suppressed by passing the FFES_NODOWNLOAD flag.

FFEffectStop

Stops playing an effect.

FFEffectUnload

Removes the effect from the device. If the effect is playing, it is automatically stopped before it is unloaded.

FFIsForceFeedback

Used to determine if a particular device provided by HID Manager is a force feedback device.

FFReleaseDevice

Disposes of an API device object created with FFCreateDevice.