Renames a file or directory on the SFTP server.

      Syntax

      public override void Rename(
         string path, 
         string newPath
      )

      Parameters

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

      Remarks

      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.

      Examples

      Shows how to use Rename method to rename a file.

      using ComponentPro.Net;
      
      ...
      
      // Create a new class instance.
      Sftp client = new Sftp();
      
      // Connect to the SFTP 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.Sftp.CF (in ComponentPro.Sftp.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.Sftp (in ComponentPro.Sftp.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.Sftp.WinPcl (in ComponentPro.Sftp.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.Sftp.Uwp (in ComponentPro.Sftp.Uwp.dll)

      Xamarin AndroidXamarin Android

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

      Xamarin MacXamarin Mac

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

      Xamarin iOSXamarin iOS

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

      See Also