Function

FFCreateDevice

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

Declaration

HRESULT FFCreateDevice(io_service_t hidDevice, FFDeviceObjectReference *pDeviceReference);

Parameters

hidDevice

Pointer to a HID device object.

pdeviceReference

Address of a variable to receive an opaque reference handle to a new device object. This reference can be used in subsequent calls to FFDevice* functions

Return Value

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

FFERR_INVALIDPARAM

FFERR_NOINTERFACE

FFERR_OUTOFMEMORY

FFERR_INTERNAL

Discussion

When you are finished with the device, FFReleaseDevice must be called on the reference received in this function to dispose of the API device object.

See Also

Miscellaneous

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.

FFDeviceGetForceFeedbackProperty

Gets properties that define the device behavior.

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.