Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpClient Class / RenameFile Method
The name of the file or folder to rename. Some FTP servers may be case-sensitive. Not all servers support renaming folders.
The new name. Some FTP servers may be case-sensitive.


In This Topic
    RenameFile Method
    In This Topic
    Renames a file or, if supported, a folder on the FTP server.
    Syntax
    'Declaration
     
    
    Public Sub RenameFile( _
       ByVal currentFilename As String, _
       ByVal newFilename As String _
    ) 
    'Usage
     
    
    Dim instance As FtpClient
    Dim currentFilename As String
    Dim newFilename As String
     
    instance.RenameFile(currentFilename, newFilename)
    public void RenameFile( 
       string currentFilename,
       string newFilename
    )

    Parameters

    currentFilename
    The name of the file or folder to rename. Some FTP servers may be case-sensitive. Not all servers support renaming folders.
    newFilename
    The new name. 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 item will be renamed in the current working folder. If you want to rename the item in 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.

    The RenameFile method will send the RNFR and RNTO commands to the FTP server. Not all servers support renaming folders with these commands.

    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