battery_info_get_battery_average_current()

Retrieve the battery average current.

Synopsis:

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

Since:

BlackBerry 10.2.0

Arguments:

info

The battery_info_t structure to get the battery average current from.

Library:

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

Description:

The battery_info_get_battery_average_current() function retrieves the average current flowing through the sense resistor of the battery from a battery_info_t structure. The battery average current is reported in milliamperes (mA).

Returns:

The battery average current or BATTERY_INVALID_VALUE if the battery average current is not available.