Location API

Overview of the Location API technology.

To develop Location API, you need these headers:

• locationapi.h
• sensorsapi.h

For programming guidance for this technology, see:

• Location API

Enumerations

LOCATION_REPORT_STATUS Defines possible status for new reports of a particular report type.

Functions

Connect Used by Windows Store app browsers in Windows 8 to notify the location platform that an app has been suspended (disconnect) and restored (connect). (ILocationPower.Connect)
Disconnect Used by Windows Store app browsers in Windows 8 to notify the location platform that an app has been suspended (disconnect) and restored (connect). (ILocationPower.Disconnect)
GetAddressLine1 Retrieves the first line of a street address.
GetAddressLine2 Retrieves the second line of a street address.
GetAltitude Retrieves the altitude, in meters. Altitude is relative to the reference ellipsoid.
GetAltitudeError Retrieves the altitude error, in meters.
GetCity Retrieves the city name.
GetCountryRegion Retrieves the two-letter country or region code.
GetDesiredAccuracy Retrieves the current requested accuracy setting.
GetDetailLevel Reserved. (ICivicAddressReport.GetDetailLevel)
GetErrorRadius Retrieves a distance from the reported location, in meters. Combined with the location reported as the origin, this radius describes the circle in which the actual location is probably located.
GetLatitude Retrieves the latitude, in degrees.
GetLongitude Retrieves the longitude, in degrees.
GetPostalCode Retrieves the postal code.
GetReport Retrieves the specified report type from the default location provider.
GetReport Retrieves a location report.
GetReportInterval Retrieves the requested amount of time, in milliseconds, between report events.
GetReportStatus Retrieves the status for the specified report type.
GetSensorID Retrieves the ID of the sensor that generated the location report.
GetStateProvince Retrieves the state or province name.
GetTimestamp Retrieves the date and time when the report was generated.
GetValue Retrieves a property value from the location report.
OnLocationChanged Called when a new location report is available.
OnStatusChanged Called when a report status changes.
RegisterForReport Requests location report events.
RequestPermissions Opens a system dialog box to request user permission to enable location devices.
SetDesiredAccuracy Specifies the accuracy to be used.
SetReport Sets the default location.
SetReportInterval Specifies the requested minimum amount of time, in milliseconds, between report events.
UnregisterForReport Stops event notifications for the specified report type.

Interfaces

ICivicAddressReport ICivicAddressReport represents a location report that contains information in the form of a street address.
IDefaultLocation IDefaultLocation provides methods used to specify or retrieve the default location.
ILatLongReport ILatLongReport represents a location report that contains information in the form of latitude and longitude.
ILocation Provides methods used to manage location reports, event registration, and sensor permissions.
ILocationEvents ILocationEvents provides callback methods that you must implement if you want to receive event notifications.
ILocationPower Used by Windows Store app browsers in Windows 8 to notify the location platform that an app has been suspended (disconnect) and restored (connect). (ILocationPower)
ILocationReport The parent interface for location reports.