<!--
{
  "availability" : [
    "macCatalyst: 13.0.0 -",
    "macOS: 10.2.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "ForceFeedback",
  "identifier" : "/documentation/ForceFeedback/FFDeviceGetForceFeedbackState(_:_:)",
  "metadataVersion" : "0.1.0",
  "role" : "Function",
  "symbol" : {
    "kind" : "Function",
    "modules" : [
      "Force Feedback"
    ],
    "preciseIdentifier" : "c:@F@FFDeviceGetForceFeedbackState"
  },
  "title" : "FFDeviceGetForceFeedbackState(_:_:)"
}
-->

# FFDeviceGetForceFeedbackState(_:_:)

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

```
func FFDeviceGetForceFeedbackState(_ deviceReference: FFDeviceObjectReference!, _ pFFState: UnsafeMutablePointer<FFState>!) -> HRESULT
```

## Parameters

`deviceReference`

An opaque reference handle to a device object. This is obtained from a previous call to FFCreateDevice.

`pFFState`

Location for flags that describe the current state of the device’s force feedback system. The value is a combination of the following constants:

    FFGFFS_ACTUATORSOFF

    The device’s force feedback actuators are disabled.

    FFGFFS_ACTUATORSON

    The device’s force feedback actuators are enabled.

    FFGFFS_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 FFSFFC_RESET command.

    FFGFFS_EMPTY

    The device has no downloaded effects.

    FFGFFS_PAUSED

    Playback of all active effects has been paused.

    FFGFFS_POWEROFF

    The force feedback system is not currently available. If the device cannot report the power state, neither FFGFFS_POWERON nor FFGFFS_POWEROFF is returned.

    FFGFFS_POWERON

    Power to the force feedback system is currently available. If the device cannot report the power state, neither FFGFFS_POWERON nor FFGFFS_POWEROFF is returned.

    FFGFFS_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 FFGFFS_SAFETYSWITCHON nor FFGFFS_SAFETYSWITCHOFF is returned.

    FFGFFS_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 FFGFFS_SAFETYSWITCHON nor FFGFFS_SAFETYSWITCHOFF is returned.

    FFGFFS_STOPPED

    No effects are playing, and the device is not paused.

    FFGFFS_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 FFGFFS_USERFFSWITCHON nor FFGFFS_USERFFSWITCHOFF is returned.

    FFGFFS_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 FFGFFS_USERFFSWITCHON nor FFGFFS_USERFFSWITCHOFF is returned.

    Future versions can define additional flags. Applications should ignore any flags that are not currently defined.

## Return Value

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

## Discussion

FFERR_INVALIDPARAM

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)