'Declaration
 
Public Overloads Function BeginDeleteFolder( _

   ByVal folder As String, _

   ByVal recursive As Boolean, _

   ByVal callback As AsyncCallback, _

   ByVal state As Object _

) As IAsyncResult

'Usage
 
Dim instance As AsyncFtpClient

Dim folder As String

Dim recursive As Boolean

Dim callback As AsyncCallback

Dim state As Object

Dim value As IAsyncResult

 

value = instance.BeginDeleteFolder(folder, recursive, callback, state)

public IAsyncResult BeginDeleteFolder( 

   string folder,

   bool recursive,

   AsyncCallback callback,

   object state

)

Parameters

folder

The name of the folder to delete. Some FTP servers may be case-sensitive!

recursive

true if each item in the folder should also be deleted; false otherwise.

callback

Callback method to be called when the asynchronous operation is completed.

state

An object containing state information for this operation.

Return Value

By default, the folder will be deleted from the current working folder. If you want to delete the folder from another location, you could use the BeginChangeCurrentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeCurrentFolder(System.IAsyncResult)% methods and/or BeginChangeToParentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeToParentFolder(System.IAsyncResult)% methods to change the current working folder. Absolute paths can also be provided, however some FTP servers might not support absolute paths and different server types may have different ways of representing absolute paths.

The current working folder can be retrieved via the BeginGetCurrentFolder%M:Xceed.Ftp.AsyncFtpClient.EndGetCurrentFolder(System.IAsyncResult)% methods.

Some FTP servers will allow folders that contain child items to be deleted, therefore, it is possible that calling this overload of the BeginDeleteFolder method with its recursive parameter set to false will still delete each item in the folder (including the folder).

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

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