NetworkInterface.GetIPProperties Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns an object that describes the configuration of this network interface.
public:
virtual System::Net::NetworkInformation::IPInterfaceProperties ^ GetIPProperties();public:
abstract System::Net::NetworkInformation::IPInterfaceProperties ^ GetIPProperties();public virtual System.Net.NetworkInformation.IPInterfaceProperties GetIPProperties();public abstract System.Net.NetworkInformation.IPInterfaceProperties GetIPProperties();abstract member GetIPProperties : unit -> System.Net.NetworkInformation.IPInterfaceProperties
override this.GetIPProperties : unit -> System.Net.NetworkInformation.IPInterfacePropertiesabstract member GetIPProperties : unit -> System.Net.NetworkInformation.IPInterfacePropertiesPublic Overridable Function GetIPProperties () As IPInterfacePropertiesPublic MustOverride Function GetIPProperties () As IPInterfacePropertiesReturns
An IPInterfaceProperties object that describes this network interface.
Examples
The following code example displays information for the local computer's network adapters that support IPv4.
public static void DisplayIPv4NetworkInterfaces()
{
NetworkInterface[] nics = NetworkInterface.GetAllNetworkInterfaces();
IPGlobalProperties properties = IPGlobalProperties.GetIPGlobalProperties();
Console.WriteLine("IPv4 interface information for {0}.{1}",
properties.HostName, properties.DomainName);
Console.WriteLine();
foreach (NetworkInterface adapter in nics)
{
// Only display informatin for interfaces that support IPv4.
if (!adapter.Supports(NetworkInterfaceComponent.IPv4))
{
continue;
}
Console.WriteLine(adapter.Description);
// Underline the description.
Console.WriteLine(String.Empty.PadLeft(adapter.Description.Length,'='));
IPInterfaceProperties adapterProperties = adapter.GetIPProperties();
// Try to get the IPv4 interface properties.
IPv4InterfaceProperties p = adapterProperties.GetIPv4Properties();
// Display the IPv4 specific data.
Console.WriteLine(" Index ............................. : {0}", p.Index);
Console.WriteLine(" MTU ............................... : {0}", p.Mtu);
Console.WriteLine(" APIPA active....................... : {0}",
p.IsAutomaticPrivateAddressingActive);
Console.WriteLine(" APIPA enabled...................... : {0}",
p.IsAutomaticPrivateAddressingEnabled);
Console.WriteLine(" Forwarding enabled................. : {0}",
p.IsForwardingEnabled);
Console.WriteLine(" Uses WINS ......................... : {0}",
p.UsesWins);
Console.WriteLine();
}
}
Public Shared Sub DisplayIPv4NetworkInterfaces()
Dim nics As NetworkInterface() = NetworkInterface.GetAllNetworkInterfaces()
Dim properties As IPGlobalProperties = IPGlobalProperties.GetIPGlobalProperties()
Console.WriteLine("IPv4 interface information for {0}.{1}", properties.HostName, properties.DomainName)
Dim adapter As NetworkInterface
For Each adapter In nics
' Only display informatin for interfaces that support IPv4.
If adapter.Supports(NetworkInterfaceComponent.IPv4) = False Then
GoTo ContinueForEach1
End If
Console.WriteLine()
Console.WriteLine(adapter.Description)
' Underline the description.
Console.WriteLine(String.Empty.PadLeft(adapter.Description.Length, "="c))
Dim adapterProperties As IPInterfaceProperties = adapter.GetIPProperties()
' Try to get the IPv4 interface properties.
Dim p As IPv4InterfaceProperties = adapterProperties.GetIPv4Properties()
' Display the IPv4 specific data.
Console.WriteLine(" Index ............................. : {0}", p.Index)
Console.WriteLine(" MTU ............................... : {0}", p.Mtu)
Console.WriteLine(" APIPA active....................... : {0}", p.IsAutomaticPrivateAddressingActive)
Console.WriteLine(" APIPA enabled...................... : {0}", p.IsAutomaticPrivateAddressingEnabled)
Console.WriteLine(" Forwarding enabled................. : {0}", p.IsForwardingEnabled)
Console.WriteLine(" Uses WINS ......................... : {0}", p.UsesWins)
ContinueForEach1:
Next adapter
End Sub
Remarks
Note that the information in the object returned by this method reflects the interfaces as of the time the array is created. This information is not updated dynamically.
