battery_info_get_battery_available

Retrieve the available energy remaining in the battery.

Synopsis:

#include <bps/battery.h>

BPS_API int battery_info_get_battery_available_energy(battery_info_t *info)

Since:

BlackBerry 10.2.0

Arguments:

info: The battery_info_t structure to get the available energy remaining in the battery from.

Library:

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

Description:

The battery_info_get_battery_available_energy() function retrieves the predicted charge or available energy remaining in the battery from a battery_info_t structure. The available energy remaining in the battery is reported in milliwatt-hours (mWh).

Returns:

The available energy remaining in the battery or BATTERY_INVALID_VALUE if the available energy remaining in the battery is not available.