ConnectionProfileFilter ConnectionProfileFilter ConnectionProfileFilter ConnectionProfileFilter Class

Definition

The ConnectionProfileFilter class defines a set of properties that are used to improve the relevance of FindConnectionProfilesAsync results.

If at least one property is not specified, it is considered a "no-op" and will not be used as for filtering.

public : sealed class ConnectionProfileFilter : IConnectionProfileFilter, IConnectionProfileFilter2
public sealed class ConnectionProfileFilter : IConnectionProfileFilter, IConnectionProfileFilter2
Public NotInheritable Class ConnectionProfileFilter Implements IConnectionProfileFilter, IConnectionProfileFilter2
var connectionProfileFilter = new connectionProfileFilter();
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Constructors

ConnectionProfileFilter() ConnectionProfileFilter() ConnectionProfileFilter() ConnectionProfileFilter()

Creates an instance of ConnectionProfileFilter, which contains a set of properties that are used to improve the relevance of FindConnectionProfilesAsync results.

public : ConnectionProfileFilter()
public ConnectionProfileFilter()
Public Sub New()
var connectionProfileFilter = new connectionProfileFilter();

Properties

IsBackgroundDataUsageRestricted IsBackgroundDataUsageRestricted IsBackgroundDataUsageRestricted IsBackgroundDataUsageRestricted

Gets or sets whether background data usage is restricted by this connection profile filter.

public : IReference<Platform::Boolean> IsBackgroundDataUsageRestricted { get; set; }
public Nullable<bool> IsBackgroundDataUsageRestricted { get; set; }
Public ReadWrite Property IsBackgroundDataUsageRestricted As Nullable<bool>
var nullable = connectionProfileFilter.isBackgroundDataUsageRestricted;
connectionProfileFilter.isBackgroundDataUsageRestricted = nullable;
Value
IReference<Platform::Boolean> Nullable<bool> Nullable<bool> Nullable<bool>

True when background data usage is restricted. False if background data usage is not restricted.

IsConnected IsConnected IsConnected IsConnected

Indicates if connection profiles that represent currently established connections are included in query results.

public : Platform::Boolean IsConnected { get; set; }
public bool IsConnected { get; set; }
Public ReadWrite Property IsConnected As bool
var bool = connectionProfileFilter.isConnected;
connectionProfileFilter.isConnected = bool;
Value
Platform::Boolean bool bool bool

A Boolean value that determines if profiles for established connections are included.

IsOverDataLimit IsOverDataLimit IsOverDataLimit IsOverDataLimit

Gets or sets whether the data limit has been exceeded under the current connection profile filter.

public : IReference<Platform::Boolean> IsOverDataLimit { get; set; }
public Nullable<bool> IsOverDataLimit { get; set; }
Public ReadWrite Property IsOverDataLimit As Nullable<bool>
var nullable = connectionProfileFilter.isOverDataLimit;
connectionProfileFilter.isOverDataLimit = nullable;
Value
IReference<Platform::Boolean> Nullable<bool> Nullable<bool> Nullable<bool>

True when the data limit has been exceeded. False otherwise.v

IsRoaming IsRoaming IsRoaming IsRoaming

Gets or sets whether roaming is active in the connection profile filter.

public : IReference<Platform::Boolean> IsRoaming { get; set; }
public Nullable<bool> IsRoaming { get; set; }
Public ReadWrite Property IsRoaming As Nullable<bool>
var nullable = connectionProfileFilter.isRoaming;
connectionProfileFilter.isRoaming = nullable;
Value
IReference<Platform::Boolean> Nullable<bool> Nullable<bool> Nullable<bool>

True when roaming, false otherwise.

IsWlanConnectionProfile IsWlanConnectionProfile IsWlanConnectionProfile IsWlanConnectionProfile

Indicates if connection profiles that represent WLAN (WiFi) connections are included in query results.

public : Platform::Boolean IsWlanConnectionProfile { get; set; }
public bool IsWlanConnectionProfile { get; set; }
Public ReadWrite Property IsWlanConnectionProfile As bool
var bool = connectionProfileFilter.isWlanConnectionProfile;
connectionProfileFilter.isWlanConnectionProfile = bool;
Value
Platform::Boolean bool bool bool

A Boolean value that indicates if WLAN (WiFi) connections are included.

IsWwanConnectionProfile IsWwanConnectionProfile IsWwanConnectionProfile IsWwanConnectionProfile

Indicates if connection profiles that represent WWAN (mobile) connections are included in query results.

public : Platform::Boolean IsWwanConnectionProfile { get; set; }
public bool IsWwanConnectionProfile { get; set; }
Public ReadWrite Property IsWwanConnectionProfile As bool
var bool = connectionProfileFilter.isWwanConnectionProfile;
connectionProfileFilter.isWwanConnectionProfile = bool;
Value
Platform::Boolean bool bool bool

A Boolean value that indicates if WWAN (mobile) connections are included.

NetworkCostType NetworkCostType NetworkCostType NetworkCostType

Defines a specific NetworkCostType value to query for.

public : NetworkCostType NetworkCostType { get; set; }
public NetworkCostType NetworkCostType { get; set; }
Public ReadWrite Property NetworkCostType As NetworkCostType
var networkCostType = connectionProfileFilter.networkCostType;
connectionProfileFilter.networkCostType = networkCostType;
Value
NetworkCostType NetworkCostType NetworkCostType NetworkCostType

The connection network cost type.

RawData RawData RawData RawData

Gets available data as raw data.

public : IBuffer RawData { get; }
public IBuffer RawData { get; }
Public ReadOnly Property RawData As IBuffer
var iBuffer = connectionProfileFilter.rawData;
Value
IBuffer IBuffer IBuffer IBuffer

Gets available raw data.

ServiceProviderGuid ServiceProviderGuid ServiceProviderGuid ServiceProviderGuid

Indicates a specific network operator ID to query for.

public : IReference<Platform::Guid> ServiceProviderGuid { get; set; }
public Nullable<Guid> ServiceProviderGuid { get; set; }
Public ReadWrite Property ServiceProviderGuid As Nullable<Guid>
var nullable = connectionProfileFilter.serviceProviderGuid;
connectionProfileFilter.serviceProviderGuid = nullable;
Value
IReference<Platform::Guid> Nullable<Guid> Nullable<Guid> Nullable<Guid>

The network operator ID.