NetworkInformation.GetInternetConnectionProfile NetworkInformation.GetInternetConnectionProfile NetworkInformation.GetInternetConnectionProfile NetworkInformation.GetInternetConnectionProfile NetworkInformation.GetInternetConnectionProfile Method

Definition

Gets the connection profile associated with the internet connection currently used by the local machine.

public : static ConnectionProfile GetInternetConnectionProfile()
static ConnectionProfile GetInternetConnectionProfile() const;
public static ConnectionProfile GetInternetConnectionProfile()
Public Shared Function GetInternetConnectionProfile() As ConnectionProfile
var connectionProfile = Windows.Networking.Connectivity.NetworkInformation.getInternetConnectionProfile();

Returns

The profile for the connection currently used to connect the machine to the Internet, or null if there is no connection profile with a suitable connection.

Remarks

To be notified of changes in connectivity, register a handler with the NetworkStatusChanged event. When a notification is received of a network status change, call the GetInternetConnectionProfile method to get the current connection profile which can then be stored for later use when needed.

The following example demonstrates how to retrieve a ConnectionProfile. The function calls getInternetConnectionProfile to retrieve the ConnectionProfile representing the connection currently used for Internet connectivity. Alternatively, your app can call getConnectionProfiles to retrieve all available connections on a device.

Note For the implementation of the GetConnectionProfileInfo method in the code below, and for additional examples of how NetworkInformation class methods are implemented to retrieve connection profiles, see Quickstart: Retrieving network connection information.

using Windows.Networking.Connectivity;

// Retrieve the ConnectionProfile.
ConnectionProfile internetConnectionProfile = NetworkInformation.GetInternetConnectionProfile();

// Pass the returned object to a function that accesses the connection data.
string connectionProfileInfo = GetConnectionProfileInfo(internetConnectionProfile);
#include <winrt/Windows.Networking.Connectivity.h>
using namespace winrt;

std::wstring GetConnectionProfileInfo(Windows::Networking::Connectivity::ConnectionProfile const& connectionProfile)
{
    ...
}

int main()
{
    winrt::init_apartment();

    // Retrieve the ConnectionProfile.
    auto internetConnectionProfile{ Windows::Networking::Connectivity::NetworkInformation::GetInternetConnectionProfile() };

    // Pass the returned object to a function that accesses the connection data.
    std::wstring strConnectionProfileInfo{ GetConnectionProfileInfo(internetConnectionProfile) };
}
using namespace Windows::Networking::Connectivity;

// Retrieve the ConnectionProfile.
ConnectionProfile^ internetConnectionProfile = NetworkInformation::GetInternetConnectionProfile();

// Pass the returned object to a function that accesses the connection data.
String^ strConnectionProfileInfo = GetConnectionProfileInfo(internetConnectionProfile);
var networkInfo = Windows.Networking.Connectivity.NetworkInformation;

// Retrieve the ConnectionProfile.
var internetConnectionProfile = networkInfo.getInternetConnectionProfile();

// Pass the returned object to a function that accesses the connection data.
var connectionProfileInfo = getConnectionProfileInfo(internetConnectionProfile);

If more than one connection profile is currently connecting the machine to the internet, the preferred profile is returned by this method. The preferred profile represents the connection that is the most likely to be used when sending and receiving traffic to and from the internet.