battery_info_get_battery_design_capacity()

Retrieve the battery design capacity.

Synopsis:

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

Since:

BlackBerry 10.2.0

Arguments:

info

The battery_info_t structure to get the battery design capacity from.

Library:

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

Description:

The battery_info_get_battery_design_capacity() function retrieves the battery design capacity from a battery_info_t structure. The battery design capacity is reported in milliampere-hours (mAh).

Returns:

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