battery_special_values_t

Values returned by battery functions to indicate special conditions.

Synopsis:

#include <bps/battery.h>
 
typedef enum {
      BATTERY_TIME_NA = 65535   
      BATTERY_INVALID_VALUE = 80000000   
} battery_special_values_t;

Since:

BlackBerry 10.2.0

Data:

BATTERY_TIME_NA
A special value returned by the battery_info_get_time_to_empty() and battery_info_get_time_to_full() functions to indicate that their value is not applicable.

For example, when the device is plugged in, the battery does not discharge, therefore a call to the battery_info_get_time_to_empty() function will return BATTERY_TIME_NA. Similarly, when the device is not plugged in, the battery does not charge, therefore, a call to the battery_info_get_time_to_full() function will return BATTERY_TIME_NA.

BATTERY_INVALID_VALUE
A special value returned by various battery info functions to indicate that there is no valid value available for the attribute.

Library:

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

Description: