battery_info_get_time_to_empty()

Retrieve the amount of time before the battery is fully discharged (empty).

Synopsis:

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

Since:

BlackBerry 10.0.0

Arguments:

info

The battery_info_t structure to get the time to empty from.

Library:

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

Description:

The battery_info_get_time_to_empty() function gets the retrieves the time the battery has left before becoming fully discharged from a battery_info_t structure.

Returns:

The time to empty (in minutes), or BATTERY_TIME_NA if the battery is not being discharged, or BPS_FAILURE on error.