GPSInfo (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

Geolocation functions

WLanguage procedure

GPSInfo

Presentation

Example

Special cases

Required permissions

Required application feature

See also

GPSInfo (Function)

In french: GPSInfo

Returns the information about the location provider used by the application for geolocation functions.

Example

// Check the type of provider used
IF GPSInfo(gpsType) = gpsSatellite THEN
Info("The phone geolocation uses the GPS system.")
END

IF GPSInfo(gpsSpeed) = False THEN
Error("The speed regarding the move of the phone cannot be defined.")
END

Syntax

<Result> = GPSInfo(<Information>)

<Result>: Variant

Requested information according to <Information>.

<Information>: Integer constant

Requested type of information.
gpsAltitude Altitude of available device. <Result> will correspond to:
True if the location provider can be used to define the device altitude,
False otherwise or if no location provider was found.
gpsDirection Direction of the move performed by the device. <Result> will correspond to:
True if the location provider can be used to define the direction of the move performed by the device,
False otherwise or if no location provider was found.
gpsEnergy Energy consumption required by the provider. <Result> will correspond to:
gpsEnergyLow: The provider must require a low quantity of energy.
gpsEnergyMedium: The provider can require a medium quantity of energy.
gpsEnergyHigh: The provider can require a high quantity of energy.
gpsPrecision Precision of the position measurement performed by the provider. <Result> will correspond to:
gpsPrecisionHigh: the position is calculated with high accuracy.
gpsPrecisionLow: the position is calculated with low accuracy.
gpsSpeed Speed of the move performed by the device. <Result> will correspond to:
True if the location provider can be used to define the speed of the move performed by the device,
False otherwise or if no location provider was found.
gpsType Type of location provider. <Result> will correspond to:
gpsSatellite: location provider via the network of GPS satellites.
gpsNetwork: location provider via the network of mobile antennas or Wi-Fi.
0 if the type of location provider was not defined.

Remarks

Special cases

It is recommended to initialize the location provider settings with GPSInitParameter before retrieving information from that provider.
The activation status of the location provider is returned by GPSStatus.

Required permissions

The call to this function modifies the permissions required by the application.
Required permission: ACCESS_FINE_LOCATION.

Android 11 specific case: This function requires the ACCESS_BACKGROUND_LOCATION permission to access the device's location.
This permission allows using the function when the application is in the background.

If the application needs to use background location:

Manually add the "ACCESS_BACKGROUND_LOCATION" permission in the Android application generation wizard.
Explicitly request background location permission with PermissionRequest. For example:

PermissionRequest(permBackgroundLocation, Callback)
INTERNAL PROCEDURE Callback(p is Permission)
IF p.Granted THEN
// Functions that require background location access can be used
END
END

A window allows users to:

allow access to the device location while the application is in the background,
allow access to the location only while the application is in use,
deny access to the location. The user can also change these permissions at any time in the Android settings.

Remarks:

Follow Google's guidelines for applications that require background location access. For more details, see https://support.google.com/googleplay/android-developer/answer/9799150. If these conditions are not met (especially user information requirements), applications may not be accepted for publication on Google Play.
The background location permission should only be requested if the location permission has been granted. Otherwise, PermissionRequest will fail.
If the option chosen by the user for the background location access request is more restrictive than the option chosen for the location access request, the application will be automatically restarted.
On devices running Android 10 or earlier, if location permission has been granted to the application, the background location permission will be granted without displaying a window.

Required application feature

When this function is used, an application feature is declared in the application generation wizard.

Required feature: Geolocation

This feature allows the applications to access the geolocation features found on the device or on the computer.

Component: wd270java.dll