BluetoothLEAdvertisementFilter Class

Reference

Definition

Namespace:: Windows.Devices.Bluetooth.Advertisement

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Groups parameters used to configure payload-based filtering of received Bluetooth LE advertisements.

public ref class BluetoothLEAdvertisementFilter sealed

/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BluetoothLEAdvertisementFilter final

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class BluetoothLEAdvertisementFilter final

[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BluetoothLEAdvertisementFilter

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class BluetoothLEAdvertisementFilter

function BluetoothLEAdvertisementFilter()

Public NotInheritable Class BluetoothLEAdvertisementFilter

Inheritance: Object Platform::Object IInspectable BluetoothLEAdvertisementFilter

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)
App capabilities	bluetooth

Remarks

A Bluetooth LE advertisement filter is applied to an advertisement event packet, and not to the device/source of the advertisement as a whole. The same device can broadcast advertisement packets with different payloads at the same time. For example, it's common for the local name to be in a different advertisement packet from the packet containing the service UUID. So, with a filter set to service UUID, the packet with local name won't be available (only packets with both service UUID and local name will be available in that case).

Constructors

BluetoothLEAdvertisementFilter()

Creates a new BluetoothLEAdvertisementFilter object.

Properties

Advertisement	A BluetoothLEAdvertisement object that can be applied as filters to received Bluetooth LE advertisements.
BytePatterns	Gets a vector of byte patterns with offsets to match advertisement sections in a received Bluetooth LE advertisement.

Applies to