TwclBluetoothLeAdvertiser.Start(TwclBluetoothRadio,Word) Method

Starts advertising.

Namespace: wclBluetooth
public
 function Start(const Radio: TwclBluetoothRadio;
 const Interval: Word = WCL_BLE_DEFAULT_ADVERTISING_INTERVAL): Integer;

Parameters

Radio
Type: TwclBluetoothRadio

The TwclBluetoothRadio object used to communicate with a remote Bluetooth device.

Interval
Type: Word

An advertising interval in 0.625 ms units. The value must be in range between WCL_BLE_MIN_ADVERTISING_INTERVAL and WCL_BLE_MAX_ADVERTISING_INTERVAL. The default value is WCL_BLE_DEFAULT_ADVERTISING_INTERVAL.

Return Value

Type: Integer

If the function succeed the return value is wclErrors.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.