geolocation_event_get_satellite_is_used()

#include <bps/geolocation.h>
 

BPS_API bool geolocation_event_get_satellite_is_used(bps_event_t *event,
                                                     int satellite_index)

Since:

BlackBerry 10.0.0

Arguments:

event

The GEOLOCATION_INFO event to extract the satellite usage flag from.

satellite_index

The index of the satellite to extract the satellite usage flag of. Must be in the range 0 to geolocation_event_get_num_satellites() - 1.

Library:

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

Description:

The geolocation_event_get_satellite_is_used() function indicates whether the satellite at the specified index in the GEOLOCATION_INFO event is used in the position solution.

Returns:

true if the satellite at the specified index is used in the position solution, false otherwise.