NetworkInformation.GetInternetConnectionProfile | getInternetConnectionProfile method

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

Syntax

var connectionProfile = Windows.Networking.Connectivity.NetworkInformation.getInternetConnectionProfile();

Parameters

This method has no parameters.

Return value

Type: ConnectionProfile

The profile for the connection currently used to connect the machine to the internet.

Remarks

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.

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.

For additional examples of how NetworkInformation class methods are implemented to retrieve connection profiles, see Quickstart: Retrieving network connection information.

Requirements

See also

NetworkInformation

Build date: 2/25/2013