IPInterfaceProperties.DhcpServerAddresses Property

Reference

Definition

Namespace:: System.Net.NetworkInformation

Assembly:: System.Net.NetworkInformation.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the addresses of Dynamic Host Configuration Protocol (DHCP) servers for this interface.

public:
 abstract property System::Net::NetworkInformation::IPAddressCollection ^ DhcpServerAddresses { System::Net::NetworkInformation::IPAddressCollection ^ get(); };

public abstract System.Net.NetworkInformation.IPAddressCollection DhcpServerAddresses { get; }

[System.Runtime.Versioning.UnsupportedOSPlatform("android")]
[System.Runtime.Versioning.UnsupportedOSPlatform("freebsd")]
[System.Runtime.Versioning.UnsupportedOSPlatform("ios")]
[System.Runtime.Versioning.UnsupportedOSPlatform("osx")]
[System.Runtime.Versioning.UnsupportedOSPlatform("tvos")]
public abstract System.Net.NetworkInformation.IPAddressCollection DhcpServerAddresses { get; }

member this.DhcpServerAddresses : System.Net.NetworkInformation.IPAddressCollection

[<System.Runtime.Versioning.UnsupportedOSPlatform("android")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("freebsd")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("osx")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>]
member this.DhcpServerAddresses : System.Net.NetworkInformation.IPAddressCollection

Public MustOverride ReadOnly Property DhcpServerAddresses As IPAddressCollection

Property Value

IPAddressCollection

An IPAddressCollection that contains the address information for DHCP servers, or an empty array if no servers are found.

Attributes: UnsupportedOSPlatformAttribute

Examples

The following code example displays the DHCP address information for the network interfaces on the local computer.

void DisplayDhcpServerAddresses()
{
   Console::WriteLine( "DHCP Servers" );
   array<NetworkInterface^>^adapters = NetworkInterface::GetAllNetworkInterfaces();
   System::Collections::IEnumerator^ myEnum19 = adapters->GetEnumerator();
   while ( myEnum19->MoveNext() )
   {
      NetworkInterface ^ adapter = safe_cast<NetworkInterface ^>(myEnum19->Current);
      IPInterfaceProperties ^ adapterProperties = adapter->GetIPProperties();
      IPAddressCollection ^ addresses = adapterProperties->DhcpServerAddresses;
      if ( addresses->Count > 0 )
      {
         Console::WriteLine( adapter->Description );
         System::Collections::IEnumerator^ myEnum20 = addresses->GetEnumerator();
         while ( myEnum20->MoveNext() )
         {
            IPAddress^ address = safe_cast<IPAddress^>(myEnum20->Current);
            Console::WriteLine( "  Dhcp Address ............................ : {0}", 
               address );
         }
         Console::WriteLine();
      }
   }
}

public static void DisplayDhcpServerAddresses()
{
    Console.WriteLine("DHCP Servers");
    NetworkInterface[] adapters  = NetworkInterface.GetAllNetworkInterfaces();
    foreach (NetworkInterface adapter in adapters)
    {

        IPInterfaceProperties adapterProperties = adapter.GetIPProperties();
        IPAddressCollection addresses = adapterProperties.DhcpServerAddresses;
        if (addresses.Count >0)
        {
            Console.WriteLine(adapter.Description);
            foreach (IPAddress address in addresses)
            {
                Console.WriteLine("  Dhcp Address ............................ : {0}",
                    address.ToString());
            }
            Console.WriteLine();
        }
    }
}

Public Shared Sub DisplayDhcpServerAddresses() 
    Console.WriteLine("DHCP Servers")
    Dim adapters As NetworkInterface() = NetworkInterface.GetAllNetworkInterfaces()
    Dim adapter As NetworkInterface
    For Each adapter In  adapters
        
        Dim adapterProperties As IPInterfaceProperties = adapter.GetIPProperties()
        Dim addresses As IPAddressCollection = adapterProperties.DhcpServerAddresses
        If addresses.Count > 0 Then
            Console.WriteLine(adapter.Description)
            Dim address As IPAddress
            For Each address In  addresses
                Console.WriteLine("  Dhcp Address ............................ : {0}", address.ToString())
            Next address
            Console.WriteLine()
        End If
    Next adapter

End Sub

Remarks

Dynamic Host Configuration Protocol (DHCP) allows a computer to obtain a network address from a DHCP server, as opposed to using a static (fixed) network address. A DHCP server does not permanently assign addresses; instead, it temporarily uses one of a number of available addresses to the computer.

Applies to

Share via