battery_info_get_battery_nominal_available_capacity()

Retrieve the battery nominal available capacity.

Synopsis:

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

Since:

BlackBerry 10.2.0

Arguments:

info

The battery_info_t structure to get the battery nominal available capacity from.

Library:

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

Description:

The battery_info_get_battery_nominal_available_capacity() function retrieves the uncompensated capacity remaining of the battery from a battery_info_t structure. The battery nominal available capacity is reported in milliampere-hours (mAh).

Returns:

The battery nominal available capacity or BATTERY_INVALID_VALUE if the battery nominal available capacity is not available.