wclBluetoothLeBeaconWatcherConnectionStart Method |
Starts monitoring for Bluetooth LE Beacons.
Namespace: wclBluetoothAssembly: wclBluetoothFramework (in wclBluetoothFramework.dll) Version: 7.19.35.0 (7.19.35.0)
Syntaxpublic int Start(
bool AllowExtendedAdvertisements,
wclBluetoothLeScanningMode ScanningMode,
wclBluetoothLeScanParametersType ScanParametersType,
ushort ScanInterval,
ushort ScanWindow
)
Public Function Start (
AllowExtendedAdvertisements As Boolean,
ScanningMode As wclBluetoothLeScanningMode,
ScanParametersType As wclBluetoothLeScanParametersType,
ScanInterval As UShort,
ScanWindow As UShort
) As Integer
public:
int Start(
bool AllowExtendedAdvertisements,
wclBluetoothLeScanningMode ScanningMode,
wclBluetoothLeScanParametersType ScanParametersType,
unsigned short ScanInterval,
unsigned short ScanWindow
)
Parameters
- AllowExtendedAdvertisements Boolean
- Set this parameter to
True to enable receiving advertisements of the Extended
Advertising format can be received. If this parameter set to
True and a hardware or OS does not support Extended
Advertisements the
WCL_E_BLUETOOTH_LE_EXT_ADV_NOT_SUPPORTED error will
be returned.
- ScanningMode wclBluetoothLeScanningMode
- Specifies the Bluetooth LE scanning
mode.
- ScanParametersType wclBluetoothLeScanParametersType
- Specifies the Bluetooth LE scan
parameters type.
- ScanInterval UInt16
- Specifies the Bluetooth LE scan in
0.625ms units. The value must be in range between 4 and
16384.
- ScanWindow UInt16
- Specifies the Bluetooth LE scan window in
0.625ms units. The value must be in range between 4 and
16384. The scan window must be less or equal to
the 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.
See Also