Renames a file or directory on the FTP server.

      Syntax

      public override void Rename(
         string path, 
         string newPath
      )

      Parameters

      path
      The filename of the file to rename. Some FTP servers may be case-sensitive.
      newPath
      The new filename. Some FTP servers may be case-sensitive.

      Remarks

      This method represents FTP RNFR/RNTO command pair.

      By default, the file will be renamed in the current working directory. If you want to rename the file from another location, you could use the SetCurrentDirectory method to change the current working directory. 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 directory can be retrieved via the GetCurrentDirectory method.

      Examples

      Shows how to use Rename method to rename a file.

      using ComponentPro.Net;
      
      ...
      
      // Create a new class instance.
      Ftp client = new Ftp();
      
      // Connect to the FTP server.
      client.Connect("myserver");
      
      // Authenticate.
      client.Authenticate("userName", "password");
      
      // ... 
       
      // Rename remote file '/file.dat' to 'myfile.dat'
      client.Rename("/file.dat", "/myfile.dat");
      
      // Move a file
      client.Rename("/file2.dat", "/new-folder/file2.dat");
      
      // Rename a remote directory
      client.Rename("/album-folder", "/old-album-folder");
      
      // Move a directory
      client.Rename("/album-folder2", "/new-folder/album-folder2");
      
      // ... 
       
      // Disconnect.
      client.Disconnect();

      Framework

      .NET Compact Framework.NET Compact Framework

      Supported version: 2.0, 3.5, and 3.9
      Assembly: ComponentPro.Ftp.CF (in ComponentPro.Ftp.CF.dll)

      .NET Framework.NET Framework

      Supported version: 2.0, 3.0, 3.5, 4.0, 4.5.x, 4.6.x and later
      Assembly: ComponentPro.Ftp (in ComponentPro.Ftp.dll)

      Portable Class Library for Windows Phone 8.1 and Windows 8.1 Store AppsPortable Class Library for Windows Phone 8.1 and Windows 8.1 Store Apps

      Supported version: 4.6.x and later
      Assembly: ComponentPro.Ftp.WinPcl (in ComponentPro.Ftp.WinPcl.dll)

      Universal Windows Platform (includes Windows 10 Mobile, Windows 10 Store Apps and Windows 10 IoT)Universal Windows Platform (includes Windows 10 Mobile, Windows 10 Store Apps and Windows 10 IoT)

      Supported version: 4.6.x and later
      Assembly: ComponentPro.Ftp.Uwp (in ComponentPro.Ftp.Uwp.dll)

      Xamarin AndroidXamarin Android

      Supported version: 2.3 and later
      Assembly: ComponentPro.Ftp.Android (in ComponentPro.Ftp.Android.dll)

      Xamarin MacXamarin Mac

      Supported version: 2.0.x and later
      Assembly: ComponentPro.Ftp.Mac (in ComponentPro.Ftp.Mac.dll)

      Xamarin iOSXamarin iOS

      Supported version: 5.1.x and later
      Assembly: ComponentPro.Ftp.iOS (in ComponentPro.Ftp.iOS.dll)

      See Also