GPSInitParameter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Special cases
Operating mode in iPhone/iPad
Required permissions
Required application feature

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

GPSInitParameter (Function)

In french: GPSInitParamètre

Initializes the parameters of geolocation WLanguage functions and finds a location provider.

To define the device position, you have the ability to use two types of "location providers":

the network of GPS satellites.
the triangulation performed from the network of mobile and Wi-Fi antennas.

Each provider differs by the precision of its information, its energy consumption and the required hardware configuration (presence of a GPS chip, Internet access, etc.).

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

New in version 18

This function is now available in Android Widget mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 22 and later

This function is now available for WINDEV applications.

New in version 22

This function is now available for WINDEV applications.

Example

// Find a location provider that can give information about the speed
// consuming an average amount of energy and providing a high level of precision
GPSInitParameter(gpsAuto, gpsPrecisionHigh + gpsSpeed + gpsEnergyMedium)

Syntax

GPSInitParameter(<Provider to find> [, <Options>])

<Provider to find>: Integer constant

Type of requested location provider.
gpsAuto Defines the most suitable provider according to the criteria specified in the <Options> parameter.
gpsNetwork Calculates the position by using the network of mobile or Wi-Fi antennas.
gpsSatellite Calculates the position by using the network of GPS satellites.

Versions 17 and later
This parameter is ignored.
New in version 17
This parameter is ignored.
This parameter is ignored.

<Options>: Optional combination of Integer constants

Selection criteria for the location provider.
This parameter is used when <Provider to find> corresponds to the gpsAuto constant. In the other cases, <Options> is ignored.
The possible values are:
gpsAltitude Indicates whether the provider must be able to specify the altitude of the device.
This constant is not available.
gpsDirection Indicates whether the provider must be able to specify the move direction of the device.
This constant is not available.
gpsEnergyHigh Indicates whether the provider can require a high quantity of energy.
This constant is not available.
gpsEnergyLow Indicates whether the provider must require a low quantity of energy.
This constant is not available.
gpsEnergyMedium Indicates whether the provider can require a medium quantity of energy.
This constant is not available.
gpsPrecisionHigh The position is calculated with a high precision.
gpsPrecisionLow The position is calculated with a low precision.
gpsSpeed Indicates whether the provider must be able to specify the moving speed.
This constant is not available.

Remarks:
The gpsPrecisionxx constants are exclusive between themselves.
The gpsEnergyxx constants are exclusive between themselves.
No constant is required. If no constant is specified, the function will search for a location provider that consumes the least amount of energy with any precision and without any specific characteristics.

Remarks

Special cases

You can get the availability of a geolocation provider using GPSStatus.
To get the characteristics of the location provider initialized by GPSInitParameter, use GPSInfo.
Depending on the type of device on which the application is started, there may be no provider corresponding to all the specified criteria (no GPS chip, no Internet access, ...).
If no providers correspond the specified criteria, these criteria are ignored one after the other until a valid provider is obtained according to the following order: energy consumption, accuracy, direction, speed and altitude.
The geolocation functions can, according to the selected setting and to the call frequency, consume a lot of resources on the device (battery, bandwidth, etc.). GPSEnd must be called when the location functions are no longer used by the application.
If a geolocation function is called while the parameters have not been defined by GPSInitParameter, the application will attempt to use the location via GPS first then the one via the network of mobile antennas if the GPS system is not available.
GPS functions cannot be used to perform an indoor geolocation: the positioning cannot be performed via Wi-Fi hotspots only.

Versions 17 and later

Operating mode in iPhone/iPad

When a GPS function is first run, the system requests geolocation permission from the user. If the user refuses, all the GPS functions used in the rest of the application will fail (fatal error).

To re-allow the use of GPS for this application, the system configuration of the application must be modified.

New in version 17

Operating mode in iPhone/iPad

When a GPS function is first run, the system requests geolocation permission from the user. If the user refuses, all the GPS functions used in the rest of the application will fail (fatal error).

To re-allow the use of GPS for this application, the system configuration of the application must be modified.

Operating mode in iPhone/iPad

When a GPS function is first run, the system requests geolocation permission from the user. If the user refuses, all the GPS functions used in the rest of the application will fail (fatal error).

To re-allow the use of GPS for this application, the system configuration of the application must be modified.

Required permissions

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

Android 10 specific case: Android 10 has implemented a new permission for the functions that allow locating the device: ACCESS_BACKGROUND_LOCATION.
This permission allows using the function when the application is in the background.
When this permission is added to the application, a window allows the user 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. 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.

Versions 21 and later

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.

New in version 21

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.

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.

Related Examples:

Cross-platform examples (WINDEV Mobile): WM Geolocation

[ + ] This example explains how to perform proximity searches with geolocation :
- search around me
- search in a city, at a given address, or close to a specific address.
The results are displayed in a looper and in a map with markers.

Android (WINDEV Mobile): Android GPS

[ + ] This example presents the use of the GPS functions of WLanguage in an Android application.
It is used to retrieve at regular interval:
- The latitude
- The longitude
- The altitude
- The speed
- The direction

Component: wd260java.dll