Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / AsyncFtpClient Class / BeginDeleteFile(String,AsyncCallback,Object) Method
The name of the file to delete. Some FTP servers may be case-sensitive!
Callback method to be called when the asynchronous operation is completed.
An object containing state information for this operation.


In This Topic
    BeginDeleteFile(String,AsyncCallback,Object) Method
    In This Topic
    Begins the process of deleting a file from the FTP server. Don't forget to call EndDeleteFile!
    Syntax
    'Declaration
     
    Public Function BeginDeleteFile( _
       ByVal file As String, _
       ByVal callback As AsyncCallback, _
       ByVal state As Object _
    ) As IAsyncResult
    'Usage
     
    Dim instance As AsyncFtpClient
    Dim file As String
    Dim callback As AsyncCallback
    Dim state As Object
    Dim value As IAsyncResult
     
    value = instance.BeginDeleteFile(file, callback, state)
    public IAsyncResult BeginDeleteFile( 
       string file,
       AsyncCallback callback,
       object state
    )

    Parameters

    file
    The name of the file to delete. Some FTP servers may be case-sensitive!
    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

    By default, the file will be deleted from the current working folder. If you want to delete the file 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.

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