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


Xceed.Ftp Assembly > Xceed.Ftp Namespace > AsyncFtpClient Class > BeginLogin Method : BeginLogin(String,String,AsyncCallback,Object) Method
The username with which to login into the FTP server.
The password with which to login into the FTP server.
Callback method to be called when the asynchronous operation is completed.
An object containing state information for this operation.
Begins the login process of the FTP client to the FTP server to which it is connected using the specified username and password. Don't forget to call EndLogin!
Syntax
'Declaration
 
Public Overloads Function BeginLogin( _
   ByVal userName As String, _
   ByVal password As String, _
   ByVal callback As AsyncCallback, _
   ByVal state As Object _
) As IAsyncResult
'Usage
 
Dim instance As AsyncFtpClient
Dim userName As String
Dim password As String
Dim callback As AsyncCallback
Dim state As Object
Dim value As IAsyncResult
 
value = instance.BeginLogin(userName, password, callback, state)
public IAsyncResult BeginLogin( 
   string userName,
   string password,
   AsyncCallback callback,
   object state
)

Parameters

userName
The username with which to login into the FTP server.
password
The password with which to login into the FTP server.
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

The FTP client must be connected to the FTP server prior to calling this method.

When using a callback, the System.IAsyncResult is provided as a parameter. You should call EndLogin in that callback. When NOT providing a callback, you should keep the returned IAsyncResult and call EndLogin with it when ready to complete. In this later case, the call to EndLogin 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