Xceed .NET Libraries Documentation
BeginConnect(String,Int32,AuthenticationMethod,VerificationFlags,Certificate,AsyncCallback,Object) Method


Xceed.Ftp Assembly > Xceed.Ftp Namespace > AsyncFtpClient Class > BeginConnect Method : BeginConnect(String,Int32,AuthenticationMethod,VerificationFlags,Certificate,AsyncCallback,Object) Method
The hostname of the FTP server to connect to. An IP address can also be used.
The port of the FTP server to which to connect to. If 0 is specified for the port, 21 will be used.
The authentication method used to connect to the FTP server.
The verification flags used to verify the FTP server's certificate.
The FTP client's certificate.
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 a secure FTP server using the specified hostname and port. Don't forget to call EndConnect! Note: This method is not available in Xceed FTP for .NET Compact Framework because this product does not support Secure FTP.
Syntax
'Declaration
 
Public Overloads Function BeginConnect( _
   ByVal hostName As String, _
   ByVal port As Integer, _
   ByVal authenticationMethod As AuthenticationMethod, _
   ByVal verificationFlags As VerificationFlags, _
   ByVal clientCertificate As Certificate, _
   ByVal callback As AsyncCallback, _
   ByVal state As Object _
) As IAsyncResult
'Usage
 
Dim instance As AsyncFtpClient
Dim hostName As String
Dim port As Integer
Dim authenticationMethod As AuthenticationMethod
Dim verificationFlags As VerificationFlags
Dim clientCertificate As Certificate
Dim callback As AsyncCallback
Dim state As Object
Dim value As IAsyncResult
 
value = instance.BeginConnect(hostName, port, authenticationMethod, verificationFlags, clientCertificate, callback, state)

Parameters

hostName
The hostname of the FTP server to connect to. An IP address can also be used.
port
The port of the FTP server to which to connect to. If 0 is specified for the port, 21 will be used.
authenticationMethod
The authentication method used to connect to the FTP server.
verificationFlags
The verification flags used to verify the FTP server's certificate.
clientCertificate
The FTP client's certificate.
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