Xceed .NET Libraries Documentation
RenameFile Method


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.
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.

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

FtpClient Class
FtpClient Members