Bluetooth Framework C++ Edition

◆ Start()

int Start ( CwclBluetoothRadio *const  Radio,
const wclBluetoothLeScanningMode  ScanningMode = smActive,
const unsigned short  ScanInterval = 189,
const unsigned short  ScanWindow = 29 
)

Starts monitoring for Bluetooth LE Beacons.

Parameters
RadioThe CwclBluetoothRadio object used to communicate with a remote Bluetooth device.
ScanningModeSpecifies the Bluetooth LE scanning mode.
ScanIntervalSpecifies the Bluetooth LE scan in 0.625 ms units. The value must be in range between WCL_BLE_MIN_SCAN_INTERVAL and WCL_BLE_MAX_SCAN_INTERVAL. The default value is WCL_BLE_DEFAULT_SCAN_INTERVAL.
ScanWindowSpecifies the Bluetooth LE scan window in 0.625 ms units. The value must be in range between WCL_BLE_MIN_SCAN_WINDOW and WCL_BLE_MAX_SCAN_WINDOW. The default value is WCL_BLE_DEFAULT_SCAN_WINDOW. The scan window must be less or equal to ScanInterval.
Returns
If the function succeed the return value is WCL_E_SUCCESS. Otherwise the method returns one of the WCL error codes.

This feature is supported on Windows 10 with the Microsoft Bluetooth drivers only. If the method returns error try to call this method with default scan parameters.

See also
CwclBluetoothRadio, wclBluetoothLeScanningMode, WCL_BLE_MIN_SCAN_WINDOW, WCL_BLE_MAX_SCAN_WINDOW, WCL_BLE_DEFAULT_SCAN_WINDOW