BluetoothFindFirstDevice function (bluetoothapis.h)

Article
02/22/2024

The BluetoothFindFirstDevice function begins the enumeration Bluetooth devices.

Syntax

HBLUETOOTH_DEVICE_FIND BluetoothFindFirstDevice(
  const BLUETOOTH_DEVICE_SEARCH_PARAMS *pbtsp,
  BLUETOOTH_DEVICE_INFO                *pbtdi
);

Parameters

pbtsp

Pointer to a BLUETOOTH_DEVICE_SEARCH_PARAMS structure. The dwSize member of the BLUETOOTH_DEVICE_SEARCH_PARAMS structure pointed to by pbtsp must match the size of the structure.

pbtdi

Pointer to a BLUETOOTH_DEVICE_INFO structure into which information about the first Bluetooth device found is placed. The dwSize member of the BLUETOOTH_DEVICE_INFO structure pointed to by pbtdi must match the size of the structure, or the call to the BluetoothFindFirstDevice function fails.

Return value

Returns a valid handle to the first Bluetooth device upon successful completion, and the pbtdi parameter points to information about the device. When this handle is no longer needed, it must be closed via the BluetoothFindDeviceClose.

Returns NULL upon failure. Call the GetLastError function for more information on the error. The following table describe common errors:

Return code	Description
ERROR_INVALID_PARAMETER	The pbtsp or pbtdi parameter is NULL.
ERROR_REVISION_MISMATCH	The structure pointed to by pbtsp or pbtdi is not the correct size.

Remarks

The BluetoothFindFirstDevice function does not find Bluetooth Low Energy (LE) devices. To access Bluetooth LE devices, use the Windows Runtime Bluetooth Low Energy APIs. The Windows Runtime APIs for Bluetooth work in both UWP and classic desktop apps.

Requirements

Requirement	Value
Minimum supported client	Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	bluetoothapis.h (include Bthsdpdef.h, BluetoothAPIs.h)
Library	Bthprops.lib
DLL	bthprops.cpl