Share via

DataPlanUsage Class

Definition

Namespace:
Windows.Networking.Connectivity
Edit

Represents data plan specific data usage information for a connection.

public ref class DataPlanUsage sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class DataPlanUsage final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class DataPlanUsage
Public NotInheritable Class DataPlanUsage
Inheritance
Object Platform::Object IInspectable DataPlanUsage
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute

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)

Examples

Check monthly usage (C#):

using Windows.Networking.Connectivity;

var profile = NetworkInformation.GetInternetConnectionProfile();
var status = profile?.GetDataPlanStatus();
var usage = status?.DataPlanUsage;
if (usage != null)
{
    // App-specific: compare usage.MegabytesUsed against your alert threshold.
}

Remarks

Retrieve this object from ConnectionProfile.GetDataPlanStatus. The reported values reflect data that the operator exposes to Windows and can lag behind real-time traffic. Treat the numbers as guidance instead of an absolute truth when deciding whether to throttle transfers.

Important

DataPlanUsage can be null even when DataPlanStatus is present. Guard for a missing value before reading MegabytesUsed to avoid null reference exceptions.

Properties

LastSyncTime

Gets a DateTime object indicating the date and time when the MegabytesUsed property was last updated.
MegabytesUsed

Gets a value indicating the total amount of data transferred, in megabytes, over the connection.

Applies to

See also