GPSDetectPosition (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Special cases
Required permissions
Required application feature

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

GPSDetectPosition (Function)

In french: GPSDétectePosition

Asks to be notified when the device gets close to a given position.

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.

Example

// Enable the notification request
GPSDetectPosition(DetectionProc, 1.145258, 30.968745)

// Procedure called during the notification
PROCEDURE DetectionProc(Enter is boolean)
IF Enter = True THEN
Info("You have reached your destination.")
END

Syntax

<Result> = GPSDetectPosition(<WLanguage procedure> , <Latitude> , <Longitude> [, <Radius> [, <Timeout>]])

<Result>: Integer

Detection identifier. This identifier can be passed in parameter to GPSStopDetection to interrupt the notification mechanism.

<WLanguage procedure>: Procedure name

Name of the WLanguage procedure ("callback" procedure) called when the device enters into or exits from the region delimited by the specified parameters.
This procedure has the following format:

PROCEDURE <Procedure name>(<Enter>, <Detection identifier>)

<Enter> is a boolean set to True if the device enters into the region defined by the specified parameters and it is set to False if it exits from the region.
<Detection identifier> is an integer corresponding to the value returned by GPSDetectPosition. This identifier is used to differentiate between the detected positions when the same procedure is used to detect several positions.
If this procedure returns False, the detection of specified position will be stopped.

<Latitude>: Real

Latitude of position whose proximity will be detected.

<Longitude>: Real

Longitude of position whose proximity will be detected.

<Radius>: Optional real

Radius (in meters) around the position whose proximity must be detected from which we want to be notified.
If this parameter is not specified, the radius around the position will be set to 50 meters.

<Timeout>: Optional integer or optional Duration

Timeout (in hundredths of a second) of the proximity alert. This timeout starts from the call to the function.
No timeout will be defined if this parameter is set to -1 or if it is not specified.
If this timeout is specified, the notification mechanism will automatically stop at the end of the timeout.
This parameter can correspond to:
an integer corresponding to the number of hundredths of a second,
a Duration variable,
Versions 23 and later
the direct indication of duration (1 s or 10 ms for example).
New in version 23
the direct indication of duration (1 s or 10 ms for example).
the direct indication of duration (1 s or 10 ms for example).

Remarks

Special cases

To stop receiving notifications, use GPSEnd.
To stop detecting the proximity of a specific position, return False in the associated procedure or use GPSStopDetection.
You can detect the proximity of several positions by calling GPSDetectPosition for each one of the positions. If the same procedure is called for several positions, you can differentiate between these positions by specifying a different value for the <Additional parameter> parameter passed to the procedure.
The position measurements can be more or less precise depending on the parameters of the location provider. Therefore, it may happen that no notification is sent if the device briefly passes near the monitored area. Similarly, a notification may be received if the device comes very close to the monitored area without entering it.

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_PERMISSION.
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.

Versions 21 and later

Required application feature

The use of this function triggers the declaration of one application feature 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

The use of this function triggers the declaration of one application feature 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

The use of this function triggers the declaration of one application feature 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.

Business / UI classification : Business Logic

Component : wd260java.dll