Xceed .NET Libraries Documentation
BeginDisconnect Method


Xceed.Ftp Assembly > Xceed.Ftp Namespace > AsyncFtpClient Class : BeginDisconnect Method
Callback method to be called when the asynchronous operation is completed.
An object containing state information for this operation.
Begins the process of disconnecting the FTP client from the FTP server to which it is connected. Don't forget to call EndDisconnect!
Syntax
'Declaration
 
Public Function BeginDisconnect( _

   ByVal callback As AsyncCallback, _

   ByVal state As Object _

) As IAsyncResult
'Usage
 
Dim instance As AsyncFtpClient

Dim callback As AsyncCallback

Dim state As Object

Dim value As IAsyncResult

 

value = instance.BeginDisconnect(callback, state)
public IAsyncResult BeginDisconnect( 

   AsyncCallback callback,

   object state

)

Parameters

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 FTP client is in an invalid state, for example, sending a file, the BeginDisconnect method will throw an exception. It is up to the user to call BeginAbort before calling BeginDisconnect.

The BeginDisconnect method will send the QUIT command to the FTP server and make sure that the command connection is closed.

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