Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpClient Class / DeleteFolder Method / DeleteFolder(String) Method
The name of the folder to delete. Some FTP servers may be case-sensitive!


In This Topic
    DeleteFolder(String) Method
    In This Topic
    Deletes a folder from the FTP server.
    Syntax
    'Declaration
     
    
    Public Overloads Sub DeleteFolder( _
       ByVal folder As String _
    ) 
    'Usage
     
    
    Dim instance As FtpClient
    Dim folder As String
     
    instance.DeleteFolder(folder)
    public void DeleteFolder( 
       string folder
    )

    Parameters

    folder
    The name of the folder to delete. Some FTP servers may be case-sensitive!
    Exceptions
    ExceptionDescription
    Cannot perform the requested operation because the FTP client is in an invalid state.
    An error reply was returned by the FTP server.
    An I/O error has occurred.
    A fatal FTP-specific error has occurred..
    Remarks

    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 ChangeCurrentFolder and/or ChangeToParentFolder 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 GetCurrentFolder method.

    This overload of the DeleteFolder method requires that the folder be empty in order to delete it. Some FTP servers will allow folders that contain child items to be deleted, therefore, it is possible that calling this overload of the DeleteFolder method will delete a folder even if it contains child items.

    The DeleteFolder method will send the RMD command to the FTP server.

    This method is the equivalent of the RemoveFolder method of the ActiveX version of the Xceed FTP Library.

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also