2 out of 6 rated this helpful - Rate this topic

IPAddress Class

Provides an Internet Protocol (IP) address.

System.Object
  System.Net.IPAddress

Namespace:  System.Net
Assembly:  System (in System.dll)
[SerializableAttribute]
public class IPAddress

The IPAddress type exposes the following members.

  Name Description
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
  Name Description
Public property Address Obsolete. An Internet Protocol (IP) address.
Public property AddressFamily Gets the address family of the IP address.
Public property IsIPv6LinkLocal Gets whether the address is an IPv6 link local address.
Public property IsIPv6Multicast Gets whether the address is an IPv6 multicast global address.
Public property IsIPv6SiteLocal Gets whether the address is an IPv6 site local address.
Public property IsIPv6Teredo Gets whether the address is an IPv6 Teredo address.
Public property ScopeId Gets or sets the IPv6 address scope identifier.
Top
  Name Description
Public method Equals Compares two IP addresses. (Overrides Object.Equals(Object).)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAddressBytes Provides a copy of the IPAddress as an array of bytes.
Public method GetHashCode Returns a hash value for an IP address. (Overrides Object.GetHashCode().)
Public method GetType Gets 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 IsLoopback Indicates whether the specified IP address is the loopback address.
Protected method MemberwiseClone Creates 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 Parse Converts an IP address string to an IPAddress instance.
Public method ToString Converts an Internet address to its standard notation. (Overrides Object.ToString().)
Public method Static member TryParse Determines whether a string is a valid IP address.
Top
  Name Description
Public field Static member Any Provides 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 Broadcast Provides the IP broadcast address. This field is read-only.
Public field Static member IPv6Any The Socket.Bind method uses the IPv6Any field to indicate that a Socket must listen for client activity on all network interfaces.
Public field Static member IPv6Loopback Provides the IP loopback address. This property is read-only.
Public field Static member IPv6None Provides an IP address that indicates that no network interface should be used. This property is read-only.
Public field Static member Loopback Provides the IP loopback address. This field is read-only.
Public field Static member None Provides an IP address that indicates that no network interface should be used. This field is read-only.
Top

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.

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();
    }

  }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Powershell equivalent demo program
function IpAddresses ([string]$server) {
    $heServer = [system.net.dns]::GetHostEntry($server)
    foreach ($curAdd in $heServer.addressList) {
        Write-Host ("Address Family: " + ($curAdd.addressfamily).ToString())
        if (($curAdd.addressfamily).tostring() -eq [system.net.sockets.addressfamily]::InterNetworkV6) {
            Write-Host ("Scope Id: " + $curAdd.ScopeId.ToString())
            }
        Write-Host ("Address: " + $curAdd.ToString())
        $bytes = $curAdd.GetAddressBytes()
        Write-Host "AddressBytes: "
        for ($i=0; $i -lt $bytes.length; $i++) {
            Write-Host $bytes[$i] -NoNewline
            }
        Write-Host "`r`n"
        } # end foreach
    } # end functionfunction IPAddressAdditionalInfo() {
   Write-Host ("SupportsIPv4: " + ([system.net.sockets.socket]::SupportsIPv4));
   Write-Host ("SupportsIPv6: " + ([system.net.sockets.socket]::SupportsIPv6));
   if ([system.net.sockets.socket]::SupportsIPv6) {
       # Display the server Any address. This IP address indicates that the server
       # should listen for client activity on all network interfaces.
       Write-Host("IPv6Any: " + [system.net.ipaddress]::IPv6Any.ToString());
       # Display the server loopback address.
       Write-Host("IPv6Loopback: " + [system.net.ipaddress]::IPv6Loopback.ToString());
       # Used during autoconfiguration first phase.
       Write-Host ("IPv6None: " + [system.net.ipaddress]::IPv6None.ToString());
       Write-Host ("IsLoopback(IPv6Loopback): " + [system.net.ipaddress]::IsLoopback([system.net.ipaddress]::IPv6Loopback));
       }
   Write-Host ("IsLoopback(Loopback): " + [system.net.ipaddress]::IsLoopback([system.net.ipaddress]::Loopback));
   }IPAddresses 'test-pc'
IPAddressAdditionalInfo