BTListDevice (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Communication

Bluetooth

WLanguage functions

WLanguage procedure

BTListDevice

Presentation

Example

See also

BTListDevice (Function)

In french: BTListePériphérique

Returns the list of accessible Bluetooth devices.

Caution: Bluetooth functions are not available in the Android emulator.

Example

sTmpString is string
sListDevices is string
// Returns the list of devices
HourGlass(True)
sListDevices = BTListDevice()
HourGlass(False)
// Clear the Table control where the devices are listed
TableDeleteAll(TABLE_Devices)
// Fills the Table control
IF sListDevices <> "" THEN
FOR EACH STRING sTmpString OF sListDevices SEPARATED BY CR
TableAdd(TABLE_Devices, sTmpString)
END
ELSE
Info(ErrorInfo(errFullDetails))
END

Syntax

<Result> = BTListDevice([<Level of details> [, <Type of elements to list> [, <Timeout> [, <Radio identifier>]]]])

<Result>: Character string

List of available Bluetooth devices,
Empty string ("") if an error occurred. ErrorInfo returns more details about the problem.
This list has the following format:
in simple mode:

<Device Identifier 1> + TAB + <MAC Address 1> + TAB + <Name 1> + CR + ...
+ CR + <Device Identifier N> + TAB + <MAC Address N> + TAB + <Name N>

in detailed mode:

<Device Identifier 1> + TAB + <MAC Address 1> + TAB + <Name 1> + TAB +
<Class 1 Identifier> + TAB + <Connected 1> + TAB + <Stored 1> + TAB +
<Authenticated 1> + TAB + <View Date 1> + TAB + <Date Used 1> + CR + ... + CR +
<Device N Identifier> + TAB + <MAC Address N> + TAB + <Name N> + TAB +
<Class N Identifier> + TAB + <Connected N> + TAB + <Stored N> + TAB +
<Authenticated N> + TAB + <View Date N> + TAB + <Date Used N>

The following information is returned:
<Device Identifier>: Identifier of the device, will be used in the Bluetooth functions that handle devices.
<MAC Address>: Physical address of the device.
<Name>: Name returned by the device (can be an empty string).
<Class Identifier>: Class of the device (32-bit integer used to get information about the type of device). This class can correspond to one of the following constants:
btCoD_NetworkAccess
btCoD_AudioVideo
btCoD_pers
btCoD_Imaging
btCoD_Unknown
btCoD_Toy
btCoD_Computer
btCoD_Device
btCoD_Phone
btCoD_Wearable
<Connected>: 1 if the device is currently "connected" to the current computer, 0 otherwise.
This information is not supported and it will always correspond to 0.
<Stored>: 1 if the device is currently "remembered" by the Bluetooth device of the current computer, 0 otherwise.
This information is not supported and it will always correspond to 0.
<Authenticated>: 1 if the device is currently authenticated beside the current computer, 0 otherwise.
<View Date>: Date and time when the device was viewed for the last time by the current computer. This date is in DDMMYYYYHHMMSS format. This information is supplied for the remembered devices only.
This information is not supported and it will always correspond to an empty string ("").
<Date Used>: Date and time when the device was last used for the last time. This date is in DDMMYYYYHHMMSS format. This information is supplied for the remembered devices only.
This information is not supported and it will always correspond to an empty string ("").

<Level of details>: Optional Integer constant

Level of result details:
btDetailedList <Result> contains the list of devices in detailed mode.
btSimpleList
(Default value) <Result> contains the list of devices in simple mode.

<Type of elements to list>: Optional Integer constant (or combination of constants)

Status of the devices to select:
btStatusAll
(Default value) Proposes all the devices.
btStatusAuthenticated Proposes the authenticated devices.
btStatusConnected Proposes the connected devices.
This constant is not available.
btStatusRemembered Proposes the remembered devices.
This constant is not available.
btStatusUnknown Proposes the unknown devices.

<Timeout>: Optional integer

Timeout in seconds (between 1 and 60) when searching for devices.
This parameter is set to 10 by default.

<Radio identifier>: Optional integer

Identifier of Bluetooth radio to use. This identifier is returned by BTListRadio.
This parameter is not supported and it will be ignored if it is specified.

Remarks

Special cases

An authenticated device is necessarily remembered (and not the other way around).
The devices are listed by interrogating the environment until the <Timeout> of the function. In this interval of time, the devices may not have sufficient time to communicate their identity. Then, all you have to do is use BTInfoDevice to get the missing information.

Limitations

This version only supports Microsoft, Bluesoleil and Broadcom (Widcomm) bluetooth stacks. Broadcom (Widcomm) stacks are not available in 64-bit mode.
To know the stack used, call BTStack.
For more details, see Which stacks to use?

Required permissions

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

Required permissions :

BLUETOOTH: this permission allows the applications to connect to the Bluetooth services.
BLUETOOTH_ADMIN: this permission allows the applications to discover and connect the Bluetooth services.
ACCESS_FINE_LOCATION: this permission allows an application to access an undefined location (Cell-ID, WiFi).

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.

Threads and hourglass

If the function is run by the main thread of the application, an hourglass (infinite progress bar) will be displayed during the detection of bluetooth devices.

To specify the message that will be displayed in the hourglass, use NextTitle before the call to BTListDevice.

Component: wd280com.dll