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

# XInputGetBatteryInformation

> XInputGetBatteryInformation

# XInputGetBatteryInformation

Recupera o tipo de bateria e o status de carga de um controle sem fio.

## Sintaxe

```cpp theme={null}
DWORD XInputGetBatteryInformation(  
         DWORD dwUserIndex,  
         BYTE devType,  
         XINPUT_BATTERY_INFORMATION* pBatteryInformation  
)  
```

### Parâmetros

*dwUserIndex*   \_In\_\
Tipo: DWORD

Índice do jogador associado ao dispositivo; um valor no intervalo de 0 a `XUSER_MAX_COUNT - 1`.

*devType*   \_In\_\
Tipo: BYTE

O tipo de dispositivo associado a *dwUserIndex* a ser consultado. Deve ser `BATTERY_DEVTYPE_GAMEPAD` ou `BATTERY_DEVTYPE_HEADSET`.

*pBatteryInformation*   \_Out\_\
Tipo: [XINPUT\_BATTERY\_INFORMATION](https://docs.xbox.com/pt-BR/reference/input/xinputongameinput/structs/xinput_battery_information.md)\*

Ponteiro para um objeto [XINPUT\_BATTERY\_INFORMATION](https://docs.xbox.com/pt-BR/reference/input/xinputongameinput/structs/xinput_battery_information.md) que recebe as informações da bateria.

### Valor retornado

Tipo: DWORD

Se a função for bem-sucedida, o valor retornado será `ERROR_SUCCESS`.

## Comentários

Os valores retornados em *pBatteryInformation* especificam o tipo de bateria e o estado de sua carga. O estado de carga é válido apenas para um dispositivo que tenha um tipo de bateria conhecido.

Para obter mais informações, consulte [O wrapper XInputOnGameInput](https://docs.xbox.com/pt-BR/build/core-features/common/input/porting/input-porting-xinput.md#xinputWrapperSection).

## Requisitos

**Cabeçalho:** XInputOnGameInput.h

**Biblioteca:** xgameruntime.lib

**Plataformas com suporte:** consoles da família XBOX One e consoles XBOX Series

## Confira também

[Portabilidade do XInput para o GameInput](https://docs.xbox.com/pt-BR/build/core-features/common/input/porting/input-porting-xinput.md)\
[XInputOnGameInput](https://docs.xbox.com/pt-BR/reference/input/xinputongameinput/xinputongameinput_members.md)


## Related topics

- [XINPUT_BATTERY_INFORMATION](https://docs.xbox.com/pt-BR/reference/input/xinputongameinput/structs/xinput_battery_information.md)
- [XInputOnGameInput (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/input/xinputongameinput/xinputongameinput_members.md)
- [IGameInputDevice::GetBatteryState (Preterido)](https://docs.xbox.com/pt-BR/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_getbatterystate.md)
- [GameInputBatteryState (Preterido)](https://docs.xbox.com/pt-BR/reference/input/gameinput/deprecated/structs/gameinputbatterystate.md)
- [GameInputBatteryStatus (Preterido)](https://docs.xbox.com/pt-BR/reference/input/gameinput/deprecated/enums/gameinputbatterystatus.md)