wclBluetoothLeBeaconWatcherStart Method |
Starts monitoring for Bluetooth LE Beacons.
Namespace: wclBluetoothAssembly: wclBluetoothFramework (in wclBluetoothFramework.dll) Version: 7.17.12.0 (7.17.12.0)
Syntax public int Start(
wclBluetoothRadio Radio,
wclBluetoothLeScanningMode ScanningMode = wclBluetoothLeScanningMode.smActive,
ushort ScanInterval = 189,
ushort ScanWindow = 29
)
Public Function Start (
Radio As wclBluetoothRadio,
Optional ScanningMode As wclBluetoothLeScanningMode = wclBluetoothLeScanningMode.smActive,
Optional ScanInterval As UShort = 189,
Optional ScanWindow As UShort = 29
) As Integer
public:
int Start(
wclBluetoothRadio^ Radio,
wclBluetoothLeScanningMode ScanningMode = wclBluetoothLeScanningMode::smActive,
unsigned short ScanInterval = 189,
unsigned short ScanWindow = 29
)
Parameters
- Radio wclBluetoothRadio
- The wclBluetoothRadio object used
to communicate with a remote Bluetooth device.
- ScanningMode wclBluetoothLeScanningMode (Optional)
- Specifies the Bluetooth LE scanning
mode.
- ScanInterval UInt16 (Optional)
- Specifies 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.
- ScanWindow UInt16 (Optional)
- Specifies 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.
Return Value
Int32 If the function succeed the return value is
WCL_E_SUCCESS. Otherwise the method returns one of
the WCL error codes.
Remarks 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