IPAddress Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Provides an Internet Protocol (IP) address.

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

System.Object
  System.Net.IPAddress

<SerializableAttribute>
Public Class IPAddress

NameDescription
System_CAPS_pubmethodIPAddress(Byte())

Initializes a new instance of the IPAddress class with the address specified as a Byte array.

System_CAPS_pubmethodIPAddress(Byte(), Int64)

Initializes a new instance of the IPAddress class with the address specified as a Byte array and the specified scope identifier.

System_CAPS_pubmethodIPAddress(Int64)

Initializes a new instance of the IPAddress class with the address specified as an Int64.

NameDescription
System_CAPS_pubpropertyAddress

Obsolete. An Internet Protocol (IP) address.

System_CAPS_pubpropertyAddressFamily

Gets the address family of the IP address.

System_CAPS_pubpropertyIsIPv4MappedToIPv6

Gets whether the IP address is an IPv4-mapped IPv6 address.

System_CAPS_pubpropertyIsIPv6LinkLocal

Gets whether the address is an IPv6 link local address.

System_CAPS_pubpropertyIsIPv6Multicast

Gets whether the address is an IPv6 multicast global address.

System_CAPS_pubpropertyIsIPv6SiteLocal

Gets whether the address is an IPv6 site local address.

System_CAPS_pubpropertyIsIPv6Teredo

Gets whether the address is an IPv6 Teredo address.

System_CAPS_pubpropertyScopeId

Gets or sets the IPv6 address scope identifier.

NameDescription
System_CAPS_pubmethodEquals(Object)

Compares two IP addresses.(Overrides Object.Equals(Object).)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetAddressBytes()

Provides a copy of the IPAddress as an array of bytes.

System_CAPS_pubmethodGetHashCode()

Returns a hash value for an IP address.(Overrides Object.GetHashCode().)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticHostToNetworkOrder(Int16)

Converts a short value from host byte order to network byte order.

System_CAPS_pubmethodSystem_CAPS_staticHostToNetworkOrder(Int32)

Converts an integer value from host byte order to network byte order.

System_CAPS_pubmethodSystem_CAPS_staticHostToNetworkOrder(Int64)

Converts a long value from host byte order to network byte order.

System_CAPS_pubmethodSystem_CAPS_staticIsLoopback(IPAddress)

Indicates whether the specified IP address is the loopback address.

System_CAPS_pubmethodMapToIPv4()

Maps the IPAddress object to an IPv4 address.

System_CAPS_pubmethodMapToIPv6()

Maps the IPAddress object to an IPv6 address.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticNetworkToHostOrder(Int16)

Converts a short value from network byte order to host byte order.

System_CAPS_pubmethodSystem_CAPS_staticNetworkToHostOrder(Int32)

Converts an integer value from network byte order to host byte order.

System_CAPS_pubmethodSystem_CAPS_staticNetworkToHostOrder(Int64)

Converts a long value from network byte order to host byte order.

System_CAPS_pubmethodSystem_CAPS_staticParse(String)

Converts an IP address string to an IPAddress instance.

System_CAPS_pubmethodToString()

Converts an Internet address to its standard notation.(Overrides Object.ToString().)

System_CAPS_pubmethodSystem_CAPS_staticTryParse(String, IPAddress)

Determines whether a string is a valid IP address.

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticAny

Provides an IP address that indicates that the server must listen for client activity on all network interfaces. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticBroadcast

Provides the IP broadcast address. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticIPv6Any

The Socket.Bind method uses the IPv6Any field to indicate that a Socket must listen for client activity on all network interfaces.

System_CAPS_pubfieldSystem_CAPS_staticIPv6Loopback

Provides the IP loopback address. This property is read-only.

System_CAPS_pubfieldSystem_CAPS_staticIPv6None

Provides an IP address that indicates that no network interface should be used. This property is read-only.

System_CAPS_pubfieldSystem_CAPS_staticLoopback

Provides the IP loopback address. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticNone

Provides an IP address that indicates that no network interface should be used. This field is read-only.

The IPAddress class contains the address of a computer on an IP network.

The following code example shows how to query a server to obtain the family addresses and the IP addresses it supports.

' This program shows how to use the IPAddress class to obtain a server 
' IP addressess and related information.
Imports System
Imports System.Net
Imports System.Net.Sockets
Imports System.Text.RegularExpressions
Imports Microsoft.VisualBasic


Namespace Mssc.Services.ConnectionManagement
  Module M_TestIPAddress

    Class TestIPAddress

      'The IPAddresses method obtains the selected server IP address information.
      'It then displays the type of address family supported by the server and 
      'its IP address in standard and byte format.
      Private Shared Sub IPAddresses(ByVal server As String)
        Try
          Dim ASCII As New System.Text.ASCIIEncoding()

          ' Get server related information.
          Dim heserver As IPHostEntry = Dns.Resolve(server)

          ' Loop on the AddressList
          Dim curAdd As IPAddress
          For Each curAdd In heserver.AddressList

            ' Display the type of address family supported by the server. If the
            ' server is IPv6-enabled this value is: InternNetworkV6. If the server
            ' is also IPv4-enabled there will be an additional value of InterNetwork.
            Console.WriteLine(("AddressFamily: " + curAdd.AddressFamily.ToString()))

            ' Display the ScopeId property in case of IPV6 addresses.
            If curAdd.AddressFamily.ToString() = ProtocolFamily.InterNetworkV6.ToString() Then
              Console.WriteLine(("Scope Id: " + curAdd.ScopeId.ToString()))
            End If

            ' Display the server IP address in the standard format. In 
            ' IPv4 the format will be dotted-quad notation, in IPv6 it will be
            ' in in colon-hexadecimal notation.
            Console.WriteLine(("Address: " + curAdd.ToString()))

            ' Display the server IP address in byte format.
            Console.Write("AddressBytes: ")



            Dim bytes As [Byte]() = curAdd.GetAddressBytes()
            Dim i As Integer
            For i = 0 To bytes.Length - 1
              Console.Write(bytes(i))
            Next i
            Console.WriteLine(ControlChars.Cr + ControlChars.Lf)
          Next curAdd 

        Catch e As Exception
          Console.WriteLine(("[DoResolve] Exception: " + e.ToString()))
        End Try
      End Sub 'IPAddresses


      ' This IPAddressAdditionalInfo displays additional server address information.
      Private Shared Sub IPAddressAdditionalInfo()
        Try
          ' Display the flags that show if the server supports IPv4 or IPv6
          ' address schemas.
          Console.WriteLine((ControlChars.Cr + ControlChars.Lf + "SupportsIPv4: " + Socket.SupportsIPv4.ToString()))
          Console.WriteLine(("SupportsIPv6: " + Socket.SupportsIPv6.ToString()))

          If Socket.SupportsIPv6 Then
            ' Display the server Any address. This IP address indicates that the server 
            ' should listen for client activity on all network interfaces. 
            Console.WriteLine((ControlChars.Cr + ControlChars.Lf + "IPv6Any: " + IPAddress.IPv6Any.ToString()))

            ' Display the server loopback address. 
            Console.WriteLine(("IPv6Loopback: " + IPAddress.IPv6Loopback.ToString()))

            ' Used during autoconfiguration first phase.
            Console.WriteLine(("IPv6None: " + IPAddress.IPv6None.ToString()))

            Console.WriteLine(("IsLoopback(IPv6Loopback): " + IPAddress.IsLoopback(IPAddress.IPv6Loopback).ToString()))
          End If
          Console.WriteLine(("IsLoopback(Loopback): " + IPAddress.IsLoopback(IPAddress.Loopback).ToString()))
        Catch e As Exception
          Console.WriteLine(("[IPAddresses] Exception: " + e.ToString()))
        End Try
      End Sub 'IPAddressAdditionalInfo

      Public Shared Sub Main(ByVal args() As String)
        Dim server As String = Nothing

        ' Define a regular expression to parse user's input.
        ' This is a security check. It allows only
        ' alphanumeric input string between 2 to 40 character long.
        'Define a regular expression to parse user's input.
        'This is a security check. It allows only
        'alphanumeric input string between 2 to 40 character long.
        Dim rex As New Regex("^[a-zA-Z]\w{1,39}$")

        If args.Length < 1 Then
          ' If no server name is passed as an argument to this program, use the current 
          ' server name as default.
          server = Dns.GetHostName()
          Console.WriteLine(("Using current host: " + server))
        Else
          server = args(0)
          If Not rex.Match(server).Success Then
            Console.WriteLine("Input string format not allowed.")
            Return
          End If
        End If

        ' Get the list of the addresses associated with the requested server.
        IPAddresses(server)

        ' Get additonal address information.
        IPAddressAdditionalInfo()
      End Sub 'Main
    End Class 'TestIPAddress
  End Module
End Namespace

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.1

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

Return to top
Show: