Xceed .NET Libraries Documentation
BeginConnect(String,AsyncCallback,Object) Method


Xceed.Ftp Assembly > Xceed.Ftp Namespace > AsyncFtpClient Class > BeginConnect Method : BeginConnect(String,AsyncCallback,Object) Method
The hostname of the FTP server to connect to. An IP address can also be used.
Callback method to be called when the asynchronous operation is completed.
An object containing state information for this operation.
Begins the connection process of the FTP client to an FTP server on port 21. Don't forget to call EndConnect!
Syntax
'Declaration
 
Public Overloads Function BeginConnect( _
   ByVal hostName As String, _
   ByVal callback As AsyncCallback, _
   ByVal state As Object _
) As IAsyncResult
'Usage
 
Dim instance As AsyncFtpClient
Dim hostName As String
Dim callback As AsyncCallback
Dim state As Object
Dim value As IAsyncResult
 
value = instance.BeginConnect(hostName, callback, state)
public IAsyncResult BeginConnect( 
   string hostName,
   AsyncCallback callback,
   object state
)

Parameters

hostName
The hostname of the FTP server to connect to. An IP address can also 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.

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

See Also

Reference

AsyncFtpClient Class
AsyncFtpClient Members
Overload List