battery_info_get_battery_voltage()

Retrieve the battery voltage.

Synopsis:

#include <bps/battery.h>
 
BPS_API int battery_info_get_battery_voltage(battery_info_t *info)

Since:

BlackBerry 10.2.0

Arguments:

info

The battery_info_t structure to get the battery voltage from.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

The battery_info_get_battery_voltage() function retrieves the battery voltage from a battery_info_t structure. The battery voltage is reported in millivolts (mV).

Returns:

The battery voltage or BATTERY_INVALID_VALUE if the battery voltage is not available.