IDirectInputEffectDriver::SendForceFeedbackCommand method (dinputd.h)

Article
02/22/2024

The IDirectInputEffectDriver::SendForceFeedbackCommand method changes the force-feedback state for the device.

Syntax

HRESULT SendForceFeedbackCommand(
  DWORD unnamedParam1,
  DWORD unnamedParam2
);

Parameters

unnamedParam1

Indicates the external joystick number being addressed.

unnamedParam2

Indicates which of the following commands is being sent:

DISFFC_RESET

Indicates that playback of any active effects should be stopped and that all effects should be removed from the device. Once the device has been reset, all effects are no longer valid and must be recreated.

DISFFC_STOPALL

Indicates that playback of all effects should be stopped. Sending the DISFFC_STOPALL command is equivalent to invoking the IDirectInputEffect::Stop method on all effects that are playing. If the device is in a paused state, the device driver is permitted to lose the paused state.

DISFFC_PAUSE

Indicates that playback of all effects should be paused. When effects are paused, time "stops" until the DISFFC_CONTINUE command is sent. For example, suppose an effect of five seconds duration is started. After one second, all effects are paused. After two more seconds, all effects are continued. The effect should then play for four additional seconds. While a force-feedback device is paused, starting a new effect or modifying existing ones can cause the paused state to be lost.

DISFFC_CONTINUE

Indicates that playback should be resumed at the point at which it was interrupted for those effects that were paused by a previous DISFFC_PAUSE command.

DISFFC_SETACTUATORSON

Indicates that the device's force-feedback actuators should be enabled.

DISFFC_SETACTUATORSOFF

Indicates that the device's force-feedback actuators should be disabled. If successful, force feedback effects are "muted". Note that time continues to elapse while actuators are off. For example, suppose an effect of five seconds' duration is started. After one second, actuators are turned off. After two more seconds, actuators are turned back on. The effect should then play for two additional seconds.

Return value

Returns S_OK if successful; otherwise, returns an error code.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dinputd.h (include Dinputd.h)

Share via