Platforms to show: All Mac Windows Linux Cross-Platform
Back to WindowsBlueToothLEMBS class.
WindowsBlueToothLEMBS.AbortReliableWrite(ReliableWriteContextID as UInt64)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
ReliableWriteContextID: The context describing the reliable write operation returned from a previous call to BeginReliableWrite.
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450791(v=vs.85).aspx
WindowsBlueToothLEMBS.BeginReliableWrite as UInt64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
Returns the ID for the context describing the reliable write operation.
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450792(v=vs.85).aspx
Some examples using this method:
WindowsBlueToothLEMBS.Characteristics(ParentService as WindowsBlueToothLEServiceMBS, Flags as Integer = 0) as WindowsBlueToothLECharacteristicMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
Service: Address of a WindowsBlueToothLEServiceMBS containing the parent service of the included services to be retrieved. This parameter is optional if a service handle was passed to Device, in which case the service specified by the service handle will be treated as the parent.
Flags: Optional flags, currently non defined.
Returned characteristics are cached upon successful retrieval of characteristics from the device directly. Unless a service-change event is received, the list of returned characteristics is not expected to change.
The parent service must be present in the cache, otherwise the function will fail. The parent service must be a service returned by either Services or IncludedServices methods.
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450795(v=vs.85).aspx
WindowsBlueToothLEMBS.Constructor(DevicePath as String)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
Takes path to device or service on device to connect.
WindowsBlueToothLEMBS.Descriptors(Characteristic as WindowsBlueToothLECharacteristicMBS, Flags as Integer = 0) as WindowsBlueToothLEDescriptorMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
Characteristic: The parent characteristic of the descriptors to be retrieved.
Returned characteristics are cached upon successful retrieval of characteristics from the device directly. Unless a service-change event is received, the list of returned characteristics is not expected to change.
The parent characteristic must be present in the cache, otherwise the function will fail. The parent service must be a service returned by either Services or IncludedServices.
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450797(v=vs.85).aspx
WindowsBlueToothLEMBS.EndReliableWrite(ReliableWriteContextID as UInt64)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
ReliableWriteContextID: The context describing the reliable write operation returned from a previous call to BeginReliableWrite.
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450794(v=vs.85).aspx
Some examples using this method:
WindowsBlueToothLEMBS.GetCharacteristicValue(Characteristic as WindowsBlueToothLECharacteristicMBS, Flags as Integer = 0) as MemoryBlock
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
Characteristic: the parent characteristic of the characteristic value to be retrieved.
Flags: Flags to modify the behavior of GetCharacteristicValue.
Flag | Description |
kFlagNone | The client does not have specific GATT requirements (default). |
kFlagConnectionEncrypted | The client requests the data to be transmitted over an encrypted channel. |
kFlagConnectionAuthenticated | The client requests the data to be transmitted over an authenticated channel. |
kFlagForceReadFromDevice | The characteristic value is to be read directly from the device. This overwrites the one in the cache if one is already present. |
kFlagForceReadFromCache | The characteristic value is to be read from the cache (regardless of whether it is present in the cache or not). |
The characteristic value is returned from the cache if one is already present. This would be the case most of the time, as all the device attributes are cached at the time of pairing or association. However, if it is not present, the characteristic value is read directly from the device, and will be cached upon successfully reading it from the device. If kFlagForceReadFromCache or kFlagForceReadFromDevice is present, the characteristic value is read using the specified method.
Returned characteristics are cached upon successful retrieval of characteristics from the device directly. Unless a service-change event is received, the list of returned characteristics is not expected to change.
The parent service must be present in the cache, otherwise the function will fail. The parent service must be a service returned by either Services or IncludedServices.
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450795(v=vs.85).aspx
Some examples using this method:
WindowsBlueToothLEMBS.GetDescriptorValue(Descriptor as WindowsBlueToothLEDescriptorMBS, Flags as Integer = 0) as WindowsBlueToothLEDescriptorValueMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
Descriptor: The parent descriptor of the descriptor value to be retrieved.
Flags: Flags to modify the behavior of GetDescriptorValue.
Flag | Description |
kFlagNone | The client does not have specific GATT requirements (default). |
kFlagConnectionEncrypted | The client requests the data to be transmitted over an encrypted channel. |
kFlagConnectionAuthenticated | The client requests the data to be transmitted over an authenticated channel. |
kFlagForceReadFromDevice | The descriptor value is to be read directly from the device. This overwrites the one in the cache if one is already present. |
kFlagForceReadFromCache | The descriptor value is to be read from the cache (regardless of whether it is present in the cache or not). |
Lasterror and LastErrorMessage properties are set.
The descriptor value is returned from the cache if one is already present. This would be the case most of the time, as all the device attributes are cached at the time of pairing or association. However, if it is not present, the descriptor value is read directly from the device, and will be cached upon successfully reading it from the device. If kFlagForceReadFromCache or kFlagForceReadFromDevice is present, the descriptor value is read using the specified method.
Returned descriptor values are cached upon successful retrieval of descriptor values from the device directly. Unless a service-change event is received, the descriptor values is not expected to change.
The parent service must be present in the cache, otherwise the function will fail. The parent service must be a service returned by either Services or IncludedServices.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450798(v=vs.85).aspx
Some examples using this method:
WindowsBlueToothLEMBS.IncludedServices(ParentService as WindowsBlueToothLEServiceMBS, Flags as Integer = 0) as WindowsBlueToothLEServiceMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
ParentService: Address of a WindowsBlueToothLEServiceMBS object that contains the parent service of the included services to be retrieved. This parameter is optional if a service handle was passed to hDevice, in which case the service specified by the service handle will be treated as the parent.
Flags: Optional flags, currently none defined.
Returned services are cached upon successful retrieval of services from the device directly. Unless a service-change event is received, the list of returned services is not expected to change.
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450800(v=vs.85).aspx
WindowsBlueToothLEMBS.RegisterChangeEvent(Characteristics() as WindowsBlueToothLECharacteristicMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
Characteristics: List of characteristics to watch for changes.
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450804(v=vs.85).aspx
Some examples using this method:
WindowsBlueToothLEMBS.Services(Flags as Integer = 0) as WindowsBlueToothLEServiceMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
Flags: Currently not used.
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450795(v=vs.85).aspx
WindowsBlueToothLEMBS.SetCharacteristicValue(Characteristic as WindowsBlueToothLECharacteristicMBS, data as MemoryBlock, ReliableWriteContextID as UInt64, Flags as Integer = 0) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
Characteristic: The object containing the parent characteristic.
CharacteristicValue: The object containing the characteristic value.
ReliableWriteContext: Optionally the context describing the reliable write operation returned from a previous call to BeginReliableWrite.
Flags: Flags to modify the behavior of SetCharacteristicValue.
Flag | Description |
kFlagNone | The client does not have specific GATT requirements (default). |
kFlagConnectionEncrypted | The client requests the data to be transmitted over an encrypted channel. |
kFlagConnectionAuthenticated | The client requests the data to be transmitted over an authenticated channel. |
kFlagWriteWithoutResponse | Write without response. |
kFlagSignedWrite | Signed write. Profile drivers must use with BLUETOOTH_GATT_FLAG_WRITE_WITHOUT_RESPONSE in order to produce signed write without a response. |
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450806(v=vs.85).aspx
Some examples using this method:
WindowsBlueToothLEMBS.SetDescriptorValue(Descriptor as WindowsBlueToothLEDescriptorMBS, DescriptorValue as WindowsBlueToothLEDescriptorValueMBS, Flags as Integer = 0) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Bluetooth | MBS Bluetooth Plugin | 18.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | All |
Descriptor: Tthe parent descriptor.
DescriptorValue: The descriptor's value.
Flags: Flags to modify the behavior of SetDescriptorValue:
Flag | Description |
kFlagNone | The client does not have specific GATT requirements (default). |
kFlagConnectionEncrypted | The client requests the data to be transmitted over an encrypted channel. |
kFlagConnectionAuthenticated | The client requests the data to be transmitted over an authenticated channel. |
Lasterror and LastErrorMessage properties are set.
see also:
https://msdn.microsoft.com/en-us/library/windows/hardware/hh450807(v=vs.85).aspx
Some examples using this method:
The items on this page are in the following plugins: MBS Bluetooth Plugin.