IPGlobalProperties.GetActiveTcpConnections Method

Definition

Namespace:

System.Net.NetworkInformation

Assembly:

System.Net.NetworkInformation.dll

Source:

IPGlobalProperties.cs

Returns information about the Internet Protocol version 4 (IPv4) and IPv6 Transmission Control Protocol (TCP) connections on the local computer.

public:
 abstract cli::array <System::Net::NetworkInformation::TcpConnectionInformation ^> ^ GetActiveTcpConnections();

[System.Runtime.Versioning.UnsupportedOSPlatform("android")]
public abstract System.Net.NetworkInformation.TcpConnectionInformation[] GetActiveTcpConnections ();

[<System.Runtime.Versioning.UnsupportedOSPlatform("android")>]
abstract member GetActiveTcpConnections : unit -> System.Net.NetworkInformation.TcpConnectionInformation[]

Public MustOverride Function GetActiveTcpConnections () As TcpConnectionInformation()

Returns

TcpConnectionInformation[]

A TcpConnectionInformation array that contains objects that describe the active TCP connections, or an empty array if no active TCP connections are detected.

Attributes

UnsupportedOSPlatformAttribute

Exceptions

NetworkInformationException

The Win32 function GetTcpTable failed.

Examples

The following example displays endpoint information for active TCP connections.

void ShowActiveTcpConnections()
{
   Console::WriteLine( "Active TCP Connections" );
   IPGlobalProperties ^ properties = IPGlobalProperties::GetIPGlobalProperties();
   array<TcpConnectionInformation^>^connections = properties->GetActiveTcpConnections();
   System::Collections::IEnumerator^ myEnum6 = connections->GetEnumerator();
   while ( myEnum6->MoveNext() )
   {
      TcpConnectionInformation ^ c = safe_cast<TcpConnectionInformation ^>(myEnum6->Current);
      Console::WriteLine( "{0} <==> {1}", c->LocalEndPoint, c->RemoteEndPoint );
   }
}

public static void ShowActiveTcpConnections()
{
           Console.WriteLine("Active TCP Connections");
           IPGlobalProperties properties = IPGlobalProperties.GetIPGlobalProperties();
           TcpConnectionInformation[] connections = properties.GetActiveTcpConnections();
           foreach (TcpConnectionInformation c in connections)
           {
               Console.WriteLine("{0} <==> {1}",
                   c.LocalEndPoint.ToString(),
                   c.RemoteEndPoint.ToString());
           }
}

Remarks

The objects returned by this method include connections in all TCP states except the Listen state. You can check the state of a connection by calling State.

The TCP protocol is defined in IETF RFC 793. Note that the objects returned by this method reflect the connections as of the time the array is created. This information is not updated dynamically.