Connect Method (IPAddress[], Int32)
Collapse the table of content
Expand the table of content

TcpClient::Connect Method (array<IPAddress^>^, Int32)

 

Connects the client to a remote TCP host using the specified IP addresses and port number.

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

public:
void Connect(
	array<IPAddress^>^ ipAddresses,
	int port
)

Parameters

ipAddresses
Type: array<System.Net::IPAddress^>^

The IPAddress array of the host to which you intend to connect.

port
Type: System::Int32

The port number to which you intend to connect.

Exception Condition
ArgumentNullException

The ipAddresses parameter is null.

ArgumentOutOfRangeException

The port number is not valid.

SocketException

An error occurred when attempting to access the socket. See the Remarks section for more information.

ObjectDisposedException

The Socket has been closed.

SecurityException

A caller higher in the call stack does not have permission for the requested operation.

NotSupportedException

This method is valid for sockets that use the InterNetwork flag or the InterNetworkV6 flag.

This method is typically used immediately after a call to the BeginGetHostAddresses method, which can return multiple IP addresses for a single host. Call the Connect method to establish a synchronous remote host connection to the host specified by the array of IPAddress elements and the port number. The Connect method will block until it either connects or fails. After connecting with the remote host, use the GetStream method to obtain the underlying NetworkStream. Use this NetworkStream to send and receive data.

System_CAPS_noteNote

If you receive a SocketException, use SocketException::ErrorCode to obtain the specific error code. After you have obtained this code, you can refer to the Windows Sockets version 2 API error code documentation in the MSDN library at http://msdn.microsoft.com/library for a detailed description of the error.

System_CAPS_noteNote

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.

The following code example uses an IP Address and port number to connect with a remote host.

static void DoConnect( String^ host, int port )
{
   // Connect to the specified host.
   TcpClient^ t = gcnew TcpClient( AddressFamily::InterNetwork );
   array<IPAddress^>^IPAddresses = Dns::GetHostAddresses( host );
   Console::WriteLine( "Establishing Connection to {0}", host );
   t->Connect( IPAddresses, port );
   Console::WriteLine( "Connection established" );
}

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft