IPInterfaceProperties.GatewayAddresses 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 IPv4 network gateway addresses for this interface.

public:
 abstract property System::Net::NetworkInformation::GatewayIPAddressInformationCollection ^ GatewayAddresses { System::Net::NetworkInformation::GatewayIPAddressInformationCollection ^ get(); };

public abstract System.Net.NetworkInformation.GatewayIPAddressInformationCollection GatewayAddresses { get; }

[System.Runtime.Versioning.UnsupportedOSPlatform("android")]
public abstract System.Net.NetworkInformation.GatewayIPAddressInformationCollection GatewayAddresses { get; }

member this.GatewayAddresses : System.Net.NetworkInformation.GatewayIPAddressInformationCollection

[<System.Runtime.Versioning.UnsupportedOSPlatform("android")>]
member this.GatewayAddresses : System.Net.NetworkInformation.GatewayIPAddressInformationCollection

Public MustOverride ReadOnly Property GatewayAddresses As GatewayIPAddressInformationCollection

Property Value

GatewayIPAddressInformationCollection

An GatewayIPAddressInformationCollection that contains the address information for network gateways, or an empty array if no gateways are found.

Attributes: UnsupportedOSPlatformAttribute

Examples

The following code example displays the gateway addresses for the network interfaces on the local computer.

void DisplayGatewayAddresses()
{
   Console::WriteLine( "Gateways" );
   array<NetworkInterface^>^adapters = NetworkInterface::GetAllNetworkInterfaces();
   System::Collections::IEnumerator^ myEnum21 = adapters->GetEnumerator();
   while ( myEnum21->MoveNext() )
   {
      NetworkInterface ^ adapter = safe_cast<NetworkInterface ^>(myEnum21->Current);
      IPInterfaceProperties ^ adapterProperties = adapter->GetIPProperties();
      GatewayIPAddressInformationCollection ^ addresses = adapterProperties->GatewayAddresses;
      if ( addresses->Count > 0 )
      {
         Console::WriteLine( adapter->Description );
         System::Collections::IEnumerator^ myEnum22 = addresses->GetEnumerator();
         while ( myEnum22->MoveNext() )
         {
            GatewayIPAddressInformation^ address = safe_cast<GatewayIPAddressInformation^>(myEnum22->Current);
            Console::WriteLine( "  Gateway Address ......................... : {0}", 
               address->Address->ToString() );
         }
         Console::WriteLine();
      }
   }
}

public static void DisplayGatewayAddresses()
{
    Console.WriteLine("Gateways");
    NetworkInterface[] adapters  = NetworkInterface.GetAllNetworkInterfaces();
    foreach (NetworkInterface adapter in adapters)
    {
        IPInterfaceProperties adapterProperties = adapter.GetIPProperties();
        GatewayIPAddressInformationCollection addresses = adapterProperties.GatewayAddresses;
        if (addresses.Count >0)
        {
            Console.WriteLine(adapter.Description);
            foreach (GatewayIPAddressInformation address in addresses)
            {
                Console.WriteLine("  Gateway Address ......................... : {0}",
                    address.Address.ToString());
            }
            Console.WriteLine();
        }
    }
}

Public Shared Sub DisplayGatewayAddresses() 
    Console.WriteLine("Gateways")
    Dim adapters As NetworkInterface() = NetworkInterface.GetAllNetworkInterfaces()
    Dim adapter As NetworkInterface
    For Each adapter In  adapters
        Dim adapterProperties As IPInterfaceProperties = adapter.GetIPProperties()
        Dim addresses As GatewayIPAddressInformationCollection = adapterProperties.GatewayAddresses
        If addresses.Count > 0 Then
            Console.WriteLine(adapter.Description)
            Dim address As GatewayIPAddressInformation
            For Each address In  addresses
                Console.WriteLine("  Gateway Address ......................... : {0}", address.ToString())
            Next address
            Console.WriteLine()
        End If
    Next adapter

End Sub

Remarks

Gateways that implement the Internet Protocol Version 4 (IPv4) to forward packets between networks are returned by this property.

Applies to

Jaa