IPv4InterfaceProperties Class
Collapse the table of content
Expand the table of content

IPv4InterfaceProperties Class

Provides information about network interfaces that support Internet Protocol version 4 (IPv4).


Namespace:  System.Net.NetworkInformation
Assembly:  System (in System.dll)

Public MustInherit Class IPv4InterfaceProperties

The IPv4InterfaceProperties type exposes the following members.

Protected methodIPv4InterfacePropertiesInitializes a new instance of the IPv4InterfaceProperties class.

Public propertyIndexGets the index of the network interface associated with the Internet Protocol version 4 (IPv4) address.
Public propertyIsAutomaticPrivateAddressingActiveGets a Boolean value that indicates whether this interface has an automatic private IP addressing (APIPA) address.
Public propertyIsAutomaticPrivateAddressingEnabledGets a Boolean value that indicates whether this interface has automatic private IP addressing (APIPA) enabled.
Public propertyIsDhcpEnabledGets a Boolean value that indicates whether the interface is configured to use a Dynamic Host Configuration Protocol (DHCP) server to obtain an IP address.
Public propertyIsForwardingEnabledGets a Boolean value that indicates whether this interface can forward (route) packets.
Public propertyMtuGets the maximum transmission unit (MTU) for this network interface.
Public propertyUsesWinsGets a Boolean value that indicates whether an interface uses Windows Internet Name Service (WINS).

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

This class provides access to configuration and address information for network interfaces that support IPv4. You do not create instances of this class; they are returned by the GetIPv4Properties method.

For IPV6 properties, see GetIPv6Properties.

The following code example gets an GetIPv4Properties object and displays its data.

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
        ' 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()

        If p Is Nothing Then
            Console.WriteLine("No IPv4 information is available for this interface.")
            GoTo ContinueForEach1
        End If
        ' 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)
    Next adapter

End Sub 'DisplayIPv4NetworkInterfaces

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

© 2016 Microsoft