IPAddress Class Home
This page is specific to:.NET Framework Version:1.12.03.03.5Silverlight 34.0
.NET Framework Class Library
IPAddress Class

Provides an Internet Protocol (IP) address.

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

'Usage

Dim instance As IPAddress

'Declaration

<SerializableAttribute> _
Public Class IPAddress
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 <mscorlib.dll>
#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 = new System::Text::ASCIIEncoding();

        // Get server related information.
        IPHostEntry* heserver = Dns::Resolve(server);

        // Loop on the AddressList
        System::Collections::IEnumerator* myEnum = heserver->AddressList->GetEnumerator();
        while (myEnum->MoveNext())
        {
            IPAddress* curAdd = __try_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(S"AddressFamily: {0}", __box(curAdd->AddressFamily));

            // Display the ScopeId property in case of IPV6 addresses.
            if(__box(curAdd->AddressFamily)->ToString() == __box(ProtocolFamily::InterNetworkV6)->ToString())
                Console::WriteLine(S"Scope Id: {0}", __box(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(S"Address: {0}", curAdd);

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



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

            Console::WriteLine(S"\r\n");

        }

    }
    catch (Exception* e) 
    {
        Console::WriteLine(S"[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(S"\r\nSupportsIPv4: {0}", __box(Socket::SupportsIPv4));
        Console::WriteLine(S"SupportsIPv6: {0}", __box(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(S"\r\nIPv6Any: {0}", IPAddress::IPv6Any);

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

            // Used during autoconfiguration first phase.
            Console::WriteLine(S"IPv6None: {0}", IPAddress::IPv6None);

            Console::WriteLine(S"IsLoopback(IPv6Loopback): {0}", __box(IPAddress::IsLoopback(IPAddress::IPv6Loopback)));
        }
        Console::WriteLine(S"IsLoopback(Loopback): {0}", __box(IPAddress::IsLoopback(IPAddress::Loopback)));
    }
    catch (Exception* e) 
    {
        Console::WriteLine(S"[IPAddresses] Exception: {0}", e);
    }
}

int main() 
{
    String* args[] = Environment::GetCommandLineArgs();

    String* server = 0;

    // 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(S"^[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(S"Using current host: {0}", server);
    }
    else
    {
        server = args[1];
        if (!(rex->Match(server))->Success)
        {
            Console::WriteLine(S"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();
}
Inheritance Hierarchy

System..::.Object
  System.Net..::.IPAddress
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.
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
See Also

Reference

Community Content

Does the System.Net.IPAddress class violate naming convention?
Added by:Samuel David Smith

For example, in the same namespace there are classes named HttpVersion, HttpWebRequest, etc. It appears that the IPAddress, IPEndPoint, IPEndPointCollection, and IPHostEntry classes don't follow the naming convention in the rest of the framework.

© 2009 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View