Platform SDK: DirectX

DirectInputDevice.GetForceFeedbackState

The DirectInputDevice.GetForceFeedbackState method retrieves the state of the device's force-feedback system.

object.GetForceFeedbackState() As CONST_DIGFFSFLAGS 

Parameters

object
Object expression that resolves to a DirectInputDevice object.

Return Values

If it succeeds, the method returns flags from the CONST_DIGFFSFLAGS enumeration that describe the current state of the device's force-feedback system.

Future versions of DirectInput may define additional flags. Applications should ignore any flags that are not currently defined.

Error Codes

If the method fails, an error is raised and Err.Number may be one of the following error codes:

DIERR_INPUTLOST
DIERR_INVALIDPARAM
DIERR_NOTEXCLUSIVEACQUIRED
DIERR_NOTINITIALIZED
DIERR_UNSUPPORTED

Remarks

The device must be acquired at the exclusive cooperative level for this method to succeed.