wmm_get_geomagnetic_field()

Returns the geomagnetic field for a location at the specified date.

Synopsis:

#include <wmm/wmm.h>

int wmm_get_geomagnetic_field(const wmm_location_t *loc, const struct tm *date, wmm_geomagnetic_field_t *field)

Since:

BlackBerry 10.0.0

Arguments:

loc: The geographic location to be used in the calculation of the magnetic field.

date: The date to be used in the calculation of the magnetic field.

field: The geomagnetic field for the given location and date.

Library:

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

Description:

The geomagnetic field is returned in field.

If the latitude_deg or longitude_deg values in loc exceed their ranges, they will be changed to fit into their respective range.

Returns:

0 if successful, -1 if an error occurred, 1 if loc was altered to fit into the magnetic model range.