DataPlanStatus Class

Definition

public ref class DataPlanStatus sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class DataPlanStatus final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class DataPlanStatus

Public NotInheritable Class DataPlanStatus

Inheritance

Object Platform::Object IInspectable DataPlanStatus

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Examples

Example (C#):

var profile = Windows.Networking.Connectivity.NetworkInformation.GetInternetConnectionProfile();
var status = profile?.GetDataPlanStatus();
if (status?.DataPlanUsage != null && status.DataLimitInMegabytes.HasValue)
{
    var used = status.DataPlanUsage.MegabytesUsed;
    var limit = status.DataLimitInMegabytes.Value;
    double pct = (double)used / limit;
    if (pct > 0.8)
    {
        // Enter reduced bandwidth mode.
    }
}

Example (C++/WinRT):

auto profile = Windows::Networking::Connectivity::NetworkInformation::GetInternetConnectionProfile();
auto status = profile ? profile.GetDataPlanStatus() : nullptr;
if (!status)
{
    return; // No data plan info available.
}

auto usage    = status.DataPlanUsage();            // May be null
auto limitRef = status.DataLimitInMegabytes();     // IReference<uint32_t>, may be null

if (usage && limitRef)
{
    auto limit = limitRef.Value();
    if (limit > 0) // Defensive: avoid divide-by-zero if a provider reports 0.
    {
        double pct = static_cast<double>(usage.MegabytesUsed()) / limit;
        if (pct > 0.8)
        {
            // Enter reduced bandwidth mode
        }
    }
}

Remarks

Obtaining an instance

Call ConnectionProfile.GetDataPlanStatus on a profile obtained via:

• NetworkInformation.GetInternetConnectionProfile
• NetworkInformation.FindConnectionProfilesAsync
• NetworkInformation.GetConnectionProfiles

Null handling

Core elements

Quota logic guidelines

• Interpret DataPlanUsage together with DataLimitInMegabytes. A missing limit means you cannot enforce a hard cap safely.
• Use both percentage consumed and time remaining before throttling; early-cycle high usage does not always justify restriction.
• Treat missing DataLimitInMegabytes as "unspecified" rather than "unlimited".

Transfer optimization

• Honor MaxTransferSizeInMegabytes by batching work into chunks at or below the recommendation.
• For background sync on metered or limited plans, schedule incremental commits instead of monolithic uploads.

Billing cycle handling

• NextBillingCycle may be absent; fall back to rolling usage display without reset logic.
• When present, derive remaining quota window precisely; operators define custom cycle boundaries.

Fallback behavior

If DataPlanStatus is null or critical fields are missing:

• Present generic usage UI without enforcement.
• Allow user override for "treat as metered" or "treat as unrestricted" preferences if your app supports it.

See also

• ConnectionProfile
• GetConnectionCost()
• NetworkConnectivity sample