BeginConnect(IPEndPoint,AsyncCallback,Object) Method

Begins the connection of the FTP client to an FTP server using the specified System.Net.IPEndPoint (IP address and port). Don't forget to call EndConnect!

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function BeginConnect( _
   ByVal serverAddress As IPEndPoint, _
   ByVal callback As AsyncCallback, _
   ByVal state As Object _
) As IAsyncResult

'Usage
 
Dim instance As AsyncFtpClient
Dim serverAddress As IPEndPoint
Dim callback As AsyncCallback
Dim state As Object
Dim value As IAsyncResult
 
value = instance.BeginConnect(serverAddress, callback, state)

public IAsyncResult BeginConnect( 
   IPEndPoint serverAddress,
   AsyncCallback callback,
   object state
)

Parameters

serverAddress: An System.Net.IPEndPoint representing the IP address and port of the FTP server to connect to. If 0 is specified for the port, 21 will be used.
callback: Callback method to be called when the asynchronous operation is completed.
state: An object containing state information for this operation.

Return Value

An System.IAsyncResult representing the status of the asynchronous operation.

Remarks

If the IP address contains a port (ie.: 192.168.0.42:2121) then the FTP client will connect on the specified port rather than port 21 (default).

This method will only connect you to the FTP server. Once connected, you must call the BeginLogin%M:Xceed.Ftp.AsyncFtpClient.EndLogin(System.IAsyncResult)% methods to log-in to the FTP server.

When using a callback, the System.IAsyncResult is provided as a parameter. You should call EndConnect in that callback. When NOT providing a callback, you should keep the returned IAsyncResult and call EndConnect with it when ready to complete. In this later case, the call to EndConnect may block until the operation completes.

Example

The following example demonstrates how to connect to an FTP server using an IPEndPoint. If you are using an IP address (ie: "192.168.0.128") or a server address (ie: "localhost" ), it is much simpler to use the overloads of the BeginConnect method that do not use an IPEndPoint.

Visual Basic
C#

Dim ftp As New AsyncFtpClient()
    
Dim host As IPHostEntry = Dns.Resolve( "localhost" )
Dim endPoint As new IPEndPoint( host.AddressList( 0 ), 21 )

Dim result As IAsyncResult = ftp.BeginConnect( endPoint, Nothing, Nothing )

While Not result.IsCompleted
    Application.DoEvents()
End While

ftp.EndConnnect( result )

AsyncFtpClient ftp = Asyncnew FtpClient();

IPHostEntry host = Dns.Resolve( "localhost" );
IPEndPoint endPoint = new IPEndPoint( host.AddressList[ 0 ], 21 );

IAsyncResult result = ftp.BeginConnect( endPoint, null, null );

while( !result.IsCompleted )
    Application.DoEvents();
    
ftp.EndConnect( result );

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

AsyncFtpClient Class
AsyncFtpClient Members
Overload List