> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GetHapticInfo

> GetHapticInfo

# GetHapticInfo

Provides dynamic information about the complete haptic properties and capabilities of an input device.

<a id="syntaxSection" />

## Syntax

```cpp theme={null}
HRESULT GetHapticInfo(
    GameInputHapticInfo* info);
```

### Parameters

*info*   \_Out\_\
Type: [GameInputHapticInfo](/reference/input/gameinput/structs/gameinputhapticinfo)\*

Structure containing haptic metadata for the current device.

### Return value

Type: HRESULT

Returns `GAMEINPUT_E_HAPTIC_NOT_FOUND` if haptic capabilities are not ready (or otherwise available) for the current device.

<a id="remarksSection" />

## Remarks

The `GetHapticInfo` method queries the haptic metadata of the current device. As haptics rely on the Windows audio stack, it is possible that this information is not yet available at the time of device arrival. Rather than calling the `GetHapticInfo` method at device connection time, it is strongly recommended to [register for device callbacks](/reference/input/gameinput/interfaces/igameinput/methods/igameinput_registerdevicecallback) and wait for the `GameInputDeviceHapticInfoReady` [device status](/reference/input/gameinput/enums/gameinputdevicestatus) notification. Doing this will ensure that haptics-capable devices receive the time required to initialize necessary resources before being polled for metadata.

<a id="requirementsSection" />

## Requirements

**Header:** GameInput.h

**Library:** gameinput.lib

**Supported platforms:** Windows, XBOX One family consoles and XBOX Series consoles

<a id="seealsoSection" />

## See also

[Overview of GameInput](/build/core-features/common/input/overviews/input-overview)<br />
[GameInputHapticInfo](/reference/input/gameinput/structs/gameinputhapticinfo)<br />
[RegisterDeviceCallback](/reference/input/gameinput/interfaces/igameinput/methods/igameinput_registerdevicecallback)<br />
[GameInputDeviceStatus](/reference/input/gameinput/enums/gameinputdevicestatus)<br />
[IGameInputDevice](/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice)

## Version History

| Version | Changes     |
| ------- | ----------- |
| **v2**  | Introduced. |
