.NET Framework Class Library
IPAddress Class

Provides an Internet Protocol (IP) address.

Inheritance Hierarchy
SystemObject
  System.NetIPAddress

Namespace:   System.Net
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/s128tyf6_en-us_VS_110_2_0_0_0_0%]> _
Public Class IPAddress
[[%$TOPIC/s128tyf6_en-us_VS_110_2_0_1_0_0%]]
public class IPAddress
[[%$TOPIC/s128tyf6_en-us_VS_110_2_0_2_0_0%]]
public ref class IPAddress
[<[%$TOPIC/s128tyf6_en-us_VS_110_2_0_3_0_0%]>]
type IPAddress =  class end

The IPAddress type exposes the following members.

Constructors
  NameDescription
Public method IPAddress(Byte)Initializes a new instance of the IPAddress class with the address specified as a Byte array.
Public method IPAddress(Int64)Initializes a new instance of the IPAddress class with the address specified as an Int64.
Public method IPAddress(Byte, Int64)Initializes a new instance of the IPAddress class with the address specified as a Byte array and the specified scope identifier.
Top
Properties
  NameDescription
Public property AddressObsolete. An Internet Protocol (IP) address.
Public property AddressFamilyGets the address family of the IP address.
Public property IsIPv4MappedToIPv6Gets whether the IP address is an IPv4-mapped IPv6 address.
Public property IsIPv6LinkLocalGets whether the address is an IPv6 link local address.
Public property IsIPv6MulticastGets whether the address is an IPv6 multicast global address.
Public property IsIPv6SiteLocalGets whether the address is an IPv6 site local address.
Public property IsIPv6TeredoGets whether the address is an IPv6 Teredo address.
Public property ScopeIdGets or sets the IPv6 address scope identifier.
Top
Methods
  NameDescription
Public method EqualsCompares two IP addresses. (Overrides ObjectEquals(Object).)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAddressBytesProvides a copy of the IPAddress as an array of bytes.
Public method GetHashCodeReturns a hash value for an IP address. (Overrides ObjectGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method Static member HostToNetworkOrder(Int16)Converts a short value from host byte order to network byte order.
Public method Static member HostToNetworkOrder(Int32)Converts an integer value from host byte order to network byte order.
Public method Static member HostToNetworkOrder(Int64)Converts a long value from host byte order to network byte order.
Public method Static member IsLoopbackIndicates whether the specified IP address is the loopback address.
Public method MapToIPv4Maps the IPAddress object to an IPv4 address.
Public method MapToIPv6Maps the IPAddress object to an IPv6 address.
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method Static member NetworkToHostOrder(Int16)Converts a short value from network byte order to host byte order.
Public method Static member NetworkToHostOrder(Int32)Converts an integer value from network byte order to host byte order.
Public method Static member NetworkToHostOrder(Int64)Converts a long value from network byte order to host byte order.
Public method Static member ParseConverts an IP address string to an IPAddress instance.
Public method ToStringConverts an Internet address to its standard notation. (Overrides ObjectToString.)
Public method Static member TryParseDetermines whether a string is a valid IP address.
Top
Fields
  NameDescription
Public field Static member AnyProvides an IP address that indicates that the server must listen for client activity on all network interfaces. This field is read-only.
Public field Static member BroadcastProvides the IP broadcast address. This field is read-only.
Public field Static member IPv6AnyThe SocketBind method uses the IPv6Any field to indicate that a Socket must listen for client activity on all network interfaces.
Public field Static member IPv6LoopbackProvides the IP loopback address. This property is read-only.
Public field Static member IPv6NoneProvides an IP address that indicates that no network interface should be used. This property is read-only.
Public field Static member LoopbackProvides the IP loopback address. This field is read-only.
Public field Static member NoneProvides an IP address that indicates that no network interface should be used. This field is read-only.
Top
Remarks

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

Examples

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
// This program shows how to use the IPAddress class to obtain a server  
// IP addressess and related information. 

using System;
using System.Net;
using System.Net.Sockets;
using System.Text.RegularExpressions;

namespace Mssc.Services.ConnectionManagement
{

  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 static void IPAddresses(string server) 
    {
      try 
      {
        System.Text.ASCIIEncoding ASCII = new System.Text.ASCIIEncoding();

        // Get server related information.
        IPHostEntry heserver = Dns.GetHostEntry(server);

        // Loop on the AddressList 
        foreach (IPAddress 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())
            Console.WriteLine("Scope Id: " + curAdd.ScopeId.ToString());


          // 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: ");



          Byte[] bytes = curAdd.GetAddressBytes();
          for (int i = 0; i < bytes.Length; i++) 
          {
            Console.Write(bytes[i]);
          }                          

          Console.WriteLine("\r\n");

        }

      }
      catch (Exception e) 
      {
        Console.WriteLine("[DoResolve] Exception: " + e.ToString());
      }
    }

    // This IPAddressAdditionalInfo displays additional server address information. 
    private static void IPAddressAdditionalInfo() 
    {
      try 
      {
        // Display the flags that show if the server supports IPv4 or IPv6 
        // address schemas.
        Console.WriteLine("\r\nSupportsIPv4: " + Socket.SupportsIPv4);
        Console.WriteLine("SupportsIPv6: " + Socket.SupportsIPv6);

        if (Socket.SupportsIPv6)
        {
          // Display the server Any address. This IP address indicates that the server  
          // should listen for client activity on all network interfaces. 
          Console.WriteLine("\r\nIPv6Any: " + 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));
        }
        Console.WriteLine("IsLoopback(Loopback): " + IPAddress.IsLoopback(IPAddress.Loopback));
      }
      catch (Exception e) 
      {
        Console.WriteLine("[IPAddresses] Exception: " + e.ToString());
      }
    }


    public static void Main(string[] args) 
    {
      string server = null;

      // 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.
      Regex rex = new Regex(@"^[a-zA-Z]\w{1,39}$");

      if (args.Length < 1)
      {
        // 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 (!(rex.Match(server)).Success)
        {
          Console.WriteLine("Input string format not allowed.");
          return;
        }
      }

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

      // Get additonal address information.
      IPAddressAdditionalInfo();
    }

  }
}
// This program shows how to use the IPAddress class to obtain a server  
// IP addressess and related information.
#using <System.dll>

using namespace System;
using namespace System::Net;
using namespace System::Net::Sockets;
using namespace System::Text::RegularExpressions;

/**
* 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.
**/ 
void IPAddresses( String^ server )
{
   try
   {
      System::Text::ASCIIEncoding^ ASCII = gcnew System::Text::ASCIIEncoding;

      // Get server related information.
      IPHostEntry^ heserver = Dns::GetHostEntry( server );

      // Loop on the AddressList
      System::Collections::IEnumerator^ myEnum = heserver->AddressList->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         IPAddress^ curAdd = safe_cast<IPAddress^>(myEnum->Current);

         // 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: {0}", curAdd->AddressFamily );

         // Display the ScopeId property in case of IPV6 addresses. 
         if ( curAdd->AddressFamily.ToString() == ProtocolFamily::InterNetworkV6.ToString() )
                  Console::WriteLine( "Scope Id: {0}", curAdd->ScopeId );

         // 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: {0}", curAdd );

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

         array<Byte>^bytes = curAdd->GetAddressBytes();
         for ( int i = 0; i < bytes->Length; i++ )
         {
            Console::Write( bytes[ i ] );

         }

         Console::WriteLine( "\r\n" );
      }
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "[DoResolve] Exception: {0}", e );
   }

}


// This IPAddressAdditionalInfo displays additional server address information. 
void IPAddressAdditionalInfo()
{
   try
   {
      // Display the flags that show if the server supports IPv4 or IPv6 
      // address schemas.
      Console::WriteLine( "\r\nSupportsIPv4: {0}", Socket::SupportsIPv4 );
      Console::WriteLine( "SupportsIPv6: {0}", Socket::SupportsIPv6 );
      if ( Socket::SupportsIPv6 )
      {
         // Display the server Any address. This IP address indicates that the server  
         // should listen for client activity on all network interfaces. 
         Console::WriteLine( "\r\nIPv6Any: {0}", IPAddress::IPv6Any );

         // Display the server loopback address. 
         Console::WriteLine( "IPv6Loopback: {0}", IPAddress::IPv6Loopback );

         // Used during autoconfiguration first phase.
         Console::WriteLine( "IPv6None: {0}", IPAddress::IPv6None );
         Console::WriteLine( "IsLoopback(IPv6Loopback): {0}", IPAddress::IsLoopback( IPAddress::IPv6Loopback ) );
      }
      Console::WriteLine( "IsLoopback(Loopback): {0}", IPAddress::IsLoopback( IPAddress::Loopback ) );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "[IPAddresses] Exception: {0}", e );
   }

}

int main()
{
   array<String^>^args = Environment::GetCommandLineArgs();
   String^ server = nullptr;

   // 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.
   Regex^ rex = gcnew Regex( "^[a-zA-Z]\\w{1,39}$" );
   if ( args->Length < 2 )
   {
      // 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: {0}", server );
   }
   else
   {
      server = args[ 1 ];
      if (  !(rex->Match(server))->Success )
      {
         Console::WriteLine( "Input string format not allowed." );
         return  -1;
      }
   }

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

   // Get additonal address information.
   IPAddressAdditionalInfo();
}
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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