Skip to content

Latest commit

 

History

History
77 lines (62 loc) · 2.22 KB

nf-xinput-xinputgetbatteryinformation.md

File metadata and controls

77 lines (62 loc) · 2.22 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:xinput.XInputGetBatteryInformation
XInputGetBatteryInformation function (xinput.h)
Retrieves the battery type and charge status of a wireless controller.
XInputGetBatteryInformation
XInputGetBatteryInformation function [XInput Game Controller APIs]
xinput.xinputgetbatteryinformation
xinput/XInputGetBatteryInformation
xinput\xinputgetbatteryinformation.htm
xinput
M:Microsoft.directx_sdk.reference.XInputGetBatteryInformation(DWORD,BYTE,XINPUT_BATTERY_INFORMATION@)
12/05/2018
XInputGetBatteryInformation, XInputGetBatteryInformation function [XInput Game Controller APIs], xinput.xinputgetbatteryinformation, xinput/XInputGetBatteryInformation
xinput.h
Windows
Xinput.lib
Xinput1_4.dll
Windows
19H1
XInputGetBatteryInformation
xinput/XInputGetBatteryInformation
c++
APIRef
kbSyntax
DllExport
xinput1_4.dll
Ext-MS-Win-Gaming-XInput-L1-1-0.dll
xinputuap.dll
XInputGetBatteryInformation

XInputGetBatteryInformation function

-description

Retrieves the battery type and charge status of a wireless controller.

-parameters

-param dwUserIndex [in]

Index of the signed-in gamer associated with the device. Can be a value in the range 0–XUSER_MAX_COUNT − 1.

-param devType [in]

Specifies which device associated with this user index should be queried. Must be BATTERY_DEVTYPE_GAMEPAD or BATTERY_DEVTYPE_HEADSET.

-param pBatteryInformation [out]

Pointer to an XINPUT_BATTERY_INFORMATION structure that receives the battery information.

-returns

If the function succeeds, the return value is ERROR_SUCCESS.

-see-also

XInput Functions