battery_event_get

Retrieve the battery information structure from a BATTERY_INFO event.

Synopsis:

#include <bps/battery.h>

BPS_API battery_info_t* battery_event_get_info(bps_event_t *event)

Since:

BlackBerry 10.0.0

Arguments:

event: The BATTERY_INFO event to get the battery information structure from.

Library:

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

Description:

You call the battery_event_get_info() function to retrieve the battery information structure from a BATTERY_INFO event. Details about the battery can be determined using the battery_info_get_*() functions. Do not use the battery_free_info() function on this battery_info_t pointer. The memory associated with the battery information structure is valid as long as the event is valid and is freed internally by BlackBerry Platform Services (BPS).

Returns:

The battery information structure.