WiFiDetectAccessPoint (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Communication

WiFi functions

WiFiDetectAccessPoint

Presentation

Example

Special cases

Required permissions

Related examples

See also

WiFiDetectAccessPoint (Function)

In french: WiFiDétectePointAccès

Starts detecting the Wi-Fi access points currently accessible from the device.

Remarks:

To add the network associated with an access point to the list of networks configured on the device, use WiFiAddNetwork.
The Wi-Fi access is not available in the Android emulator.

Example

NextTitle("Detecting the Wi-Fi access points")

ListPoint is string
sSSID is string
sBSSID is string

ListPoint = WiFiDetectAccessPoint()
FOR EACH STRING AccessPoint OF ListPoint SEPARATED BY CR
sSSID = ExtractString(AccessPoint, 2, TAB)
sBSSID = ExtractString(AccessPoint, 3, TAB)
...
END

Syntax

<Result> = WiFiDetectAccessPoint([<Timeout>])

<Result>: Character string

List of detected Wi-Fi access points separated by CR characters (Carriage Return),
Empty string ("") if no Wi-Fi access point was detected. The ErrorOccurred variable is used to find out whether an error occurred while detecting the access points. ErrorInfo returns more information on the error.
For each network, a set of information is returned in the following format:

<Identifier> + TAB + <SSID> + TAB + <BSSID> +
TAB + <Security> + TAB + <Signal strength>

where:
<Identifier> : Identifier of the network associated with the access point, empty string ("") if the access point corresponds to no network configured on the device.
<SSID>: SSID (Service Set Identifier) of the Wi-Fi network associated with the access point.
<BSSID>: BSSID (Basic Service Set Identifier) of access point
<Security>: Type of security used by the Wi-Fi network:
wifiSecurityIEEE8021X Security that is using the IEEE 802.1x standard.
wifiSecurityNone No security is used.
wifiSecurityWEP Security based on a WEP key (Wired Equivalent Privacy)
wifiSecurityWPA2 Security that is using the WPA2 mechanism (Wi-Fi Protected Access).
wifiSecurityWPA Security that is using the WPA mechanism (Wi-Fi Protected Access).
wifiSecurityWPA_EAP Security that is using the WPA mechanism (Wi-Fi Protected Access) and the EAP mechanism (Extensible Authentication Protocol).
<Signal strength>: Signal strength expressed in dBm (decibel per milliwatt).

<Timeout>: Optional integer or optional Duration

Maximum duration of detection in hundredths of a second.
An error occurs if this timeout is reached before the end of detection.
If this timeout is not specified or is set to 0, no time limit will be applied.
This parameter can correspond to:
an integer corresponding to the number of hundredths of a second,
a Duration variable,
the duration in a readable format (e.g., 1 s or 10 ms).

Remarks

Special cases

The list of access points returned by WiFiDetectAccessPoint is sorted by order of signal strength (from the strongest signal to the weakest).
If the function is run by the main thread of the application, an hourglass (infinite progress bar) will be displayed during the detection of access points. To specify the message that will be displayed in the hourglass, use NextTitle before the call to WiFiDetectAccessPoint.
From Android 6.0: The location must be enabled on the device. Otherwise, the function will return an empty list. GPSStatus is used to find out whether the location is enabled or not.

Required permissions

The call to this function modifies the permissions required by the application.

Required permissions :

ACCESS_WIFI_STATE: Allows the applications to access the information regarding the Wi-Fi networks.
CHANGE_WIFI_STATE: Allows the applications to modify the Wi-Fi connectivity status.

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.

Related Examples:

Cross-platform examples (WINDEV Mobile): WM System

[ + ] This application is an example of some of the features of WINDEV Mobile available for Android/iOS.
The following system functions are used:
- NFC
- Multimedia control
- Brightness
- Volume
- Wi-Fi
- Bluetooth
- Toast
- Compass
- Accelerometer
- Camera control
- LED
- Vibration
- Notifications
- Drawing functions
- Internet

Component: wd270com.dll