IPAddress Class

Definition

提供 Internet 协议 (IP) 地址。Provides an Internet Protocol (IP) address.

public ref class IPAddress
public class IPAddress
[System.Serializable]
public class IPAddress
type IPAddress = class
Public Class IPAddress
Inheritance
IPAddress
Attributes

Examples

下面的代码示例演示如何查询服务器以获取其所支持的系列地址和 IP 地址。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.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: InterNetworkV6. 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 additional address information.
   IPAddressAdditionalInfo();
}

// 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: InterNetworkV6. 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 additional address information.
      IPAddressAdditionalInfo();
    }
  }
}
' This program shows how to use the IPAddress class to obtain a server 
' IP addressess and related information.
Imports System.Net
Imports System.Net.Sockets
Imports System.Text.RegularExpressions

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: InterNetworkV6. 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


      ' 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

      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.
        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 additional address information.
        IPAddressAdditionalInfo()
      End Sub
    End Class
  End Module
End Namespace

Remarks

IPAddress 类包含 IP 网络上的计算机的地址。The IPAddress class contains the address of a computer on an IP network.

Constructors

IPAddress(Byte[])

使用指定为 IPAddress 数组的地址初始化 Byte 类的新实例。Initializes a new instance of the IPAddress class with the address specified as a Byte array.

IPAddress(Byte[], Int64)

使用指定为 IPAddress 数组的地址和指定的范围标识符初始化 Byte 类的新实例。Initializes a new instance of the IPAddress class with the address specified as a Byte array and the specified scope identifier.

IPAddress(Int64)

使用指定为 IPAddress 的地址初始化 Int64 类的新实例。Initializes a new instance of the IPAddress class with the address specified as an Int64.

IPAddress(ReadOnlySpan<Byte>)

使用指定为字节范围的地址初始化 IPAddress 类的新实例。Initializes a new instance of the IPAddress class with the address specified as a byte span.

IPAddress(ReadOnlySpan<Byte>, Int64)

使用指定为字节范围的地址和指定的范围标识符初始化 IPAddress 类的新实例。Initializes a new instance of the IPAddress class with the address specified as a byte span and the specified scope identifier.

Fields

Any

提供一个 IP 地址,指示服务器必须侦听所有网络接口上的客户端活动。Provides an IP address that indicates that the server must listen for client activity on all network interfaces. 此字段为只读。This field is read-only.

Broadcast

提供 IP 广播地址。Provides the IP broadcast address. 此字段为只读。This field is read-only.

IPv6Any

Bind(EndPoint) 方法使用 IPv6Any 字段指示 Socket 必须侦听所有网络接口上的客户端活动。The Bind(EndPoint) method uses the IPv6Any field to indicate that a Socket must listen for client activity on all network interfaces.

IPv6Loopback

提供 IP 环回地址。Provides the IP loopback address. 此属性为只读。This property is read-only.

IPv6None

提供指示不应使用任何网络接口的 IP 地址。Provides an IP address that indicates that no network interface should be used. 此属性为只读。This property is read-only.

Loopback

提供 IP 环回地址。Provides the IP loopback address. 此字段为只读。This field is read-only.

None

提供指示不应使用任何网络接口的 IP 地址。Provides an IP address that indicates that no network interface should be used. 此字段为只读。This field is read-only.

Properties

Address

Internet 协议 (IP) 地址。An Internet Protocol (IP) address.

AddressFamily

获取 IP 地址的地址族。Gets the address family of the IP address.

IsIPv4MappedToIPv6

了解 IP 地址是否为 IPv4 映射的 IPv6 地址。Gets whether the IP address is an IPv4-mapped IPv6 address.

IsIPv6LinkLocal

了解地址是否为 IPv6 链路本地地址。Gets whether the address is an IPv6 link local address.

IsIPv6Multicast

了解地址是否为 IPv6 多播全局地址。Gets whether the address is an IPv6 multicast global address.

IsIPv6SiteLocal

了解地址是否为 IPv6 站点本地地址。Gets whether the address is an IPv6 site local address.

IsIPv6Teredo

了解地址是否为 IPv6 Teredo 地址。Gets whether the address is an IPv6 Teredo address.

ScopeId

获取或设置 IPv6 地址范围标识符。Gets or sets the IPv6 address scope identifier.

Methods

Equals(Object)

比较两个 IP 地址。Compares two IP addresses.

GetAddressBytes()

以字节数组形式提供 IPAddress 的副本。Provides a copy of the IPAddress as an array of bytes.

GetHashCode()

返回 IP 地址的哈希值。Returns a hash value for an IP address.

GetType()

获取当前实例的 TypeGets the Type of the current instance.

(Inherited from Object)
HostToNetworkOrder(Int16)

将短值由主机字节顺序转换为网络字节顺序。Converts a short value from host byte order to network byte order.

HostToNetworkOrder(Int32)

将整数值由主机字节顺序转换为网络字节顺序。Converts an integer value from host byte order to network byte order.

HostToNetworkOrder(Int64)

将长值由主机字节顺序转换为网络字节顺序。Converts a long value from host byte order to network byte order.

IsLoopback(IPAddress)

指示指定的 IP 地址是否为环回地址。Indicates whether the specified IP address is the loopback address.

MapToIPv4()

IPAddress 对象映射到 IPv4 地址。Maps the IPAddress object to an IPv4 address.

MapToIPv6()

IPAddress 对象映射到 IPv6 地址。Maps the IPAddress object to an IPv6 address.

MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(Inherited from Object)
NetworkToHostOrder(Int16)

将短值由网络字节顺序转换为主机字节顺序。Converts a short value from network byte order to host byte order.

NetworkToHostOrder(Int32)

将整数值由网络字节顺序转换为主机字节顺序。Converts an integer value from network byte order to host byte order.

NetworkToHostOrder(Int64)

将长值由网络字节顺序转换为主机字节顺序。Converts a long value from network byte order to host byte order.

Parse(ReadOnlySpan<Char>)

将以字符范围表示的 IP 地址转换为 IPAddress 实例。Converts an IP address represented as a character span to an IPAddress instance.

Parse(String)

将 IP 地址字符串转换为 IPAddress 实例。Converts an IP address string to an IPAddress instance.

ToString()

将 Internet 地址转换为标准表示法。Converts an Internet address to its standard notation.

TryFormat(Span<Char>, Int32)

尝试将当前 IP 地址格式化为提供的范围。Tries to format the current IP address into the provided span.

TryParse(ReadOnlySpan<Char>, IPAddress)

确定指定的字节范围是否表示有效的 IP 地址。Determines whether the specified byte span represents a valid IP address.

TryParse(String, IPAddress)

确定字符串是否为有效 IP 地址。Determines whether a string is a valid IP address.

TryWriteBytes(Span<Byte>, Int32)

尝试将当前 IP 地址写为一段字节。Tries to write the current IP address into a span of bytes.

Applies to