IDirectInputDevice8::GetForceFeedbackState
Retrieves the state of the device's force-feedback system.
HRESULT GetForceFeedbackState(
LPDWORD pdwOut
);
Parameters
- pdwOut
- Location for flags that describe the current state of the device's force-feedback system.
The value is a combination of the following constants:
- DIGFFS_ACTUATORSOFF
- The device's force-feedback actuators are disabled.
- DIGFFS_ACTUATORSON
- The device's force-feedback actuators are enabled.
- DIGFFS_DEVICELOST
- The device suffered an unexpected failure and is in an indeterminate state. It must be reset either by unacquiring and reacquiring the device, or by sending a DISFFC_RESET command.
- DIGFFS_EMPTY
- The device has no downloaded effects.
- DIGFFS_PAUSED
- Playback of all active effects has been paused.
- DIGFFS_POWEROFF
- The force-feedback system is not currently available. If the device cannot report the power state, neither DIGFFS_POWERON nor DIGFFS_POWEROFF is returned.
- DIGFFS_POWERON
- Power to the force-feedback system is currently available. If the device cannot report the power state, neither DIGFFS_POWERON nor DIGFFS_POWEROFF is returned.
- DIGFFS_SAFETYSWITCHOFF
- The safety switch is currently off; that is, the device cannot operate. If the device cannot report the state of the safety switch, neither DIGFFS_SAFETYSWITCHON nor DIGFFS_SAFETYSWITCHOFF is returned.
- DIGFFS_SAFETYSWITCHON
- The safety switch is currently on; that is, the device can operate. If the device cannot report the state of the safety switch, neither DIGFFS_SAFETYSWITCHON nor DIGFFS_SAFETYSWITCHOFF is returned.
- DIGFFS_STOPPED
- No effects are playing, and the device is not paused.
- DIGFFS_USERFFSWITCHOFF
- The user force-feedback switch is currently off; that is, the device cannot operate. If the device cannot report the state of the user force-feedback switch, neither DIGFFS_USERFFSWITCHON nor DIGFFS_USERFFSWITCHOFF is returned.
- DIGFFS_USERFFSWITCHON
- The user force-feedback switch is currently on; that is, the device can operate. If the device cannot report the state of the user force-feedback switch, neither DIGFFS_USERFFSWITCHON nor DIGFFS_USERFFSWITCHOFF is returned.
Future versions of Microsoft® DirectInput® can define additional flags. Applications should ignore any flags that are not currently defined.
Return Values
If the method succeeds, the return value is DI_OK.
If the method fails, the return value can be one of the following error values:
Remarks
The device must be acquired at the exclusive cooperative level for this method to succeed.
Windows NT/2000: Requires Windows® 2000.
Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
Header: Declared in Dinput.h.