battery_info_is_battery_ok()

Retrieve status of the battery.

Synopsis:

#include <bps/battery.h>
 
BPS_API bool battery_info_is_battery_ok(battery_info_t *info)

Since:

BlackBerry 10.0.0

Arguments:

info

The battery_info_t structure to get the battery OK status from.

Library:

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

Description:

The battery_info_is_battery_ok() function gets whether the battery is OK from a battery_info_t structure. If the battery is not OK, it may indicate a problem with the battery or that the battery is not ready.

Returns:

true if the battery is OK, false if the battery is not OK or if the battery was not ready.