ComponentPro UltimateSftp

      DownloadFile(String, String, Int64, Int64) Method

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      Downloads the specified part of the remote file to the specified offset of the local file.

      Syntax

      public long DownloadFile(
         string remotePath, 
         string localPath, 
         long remoteOffset, 
         long localOffset
      )

      Parameters

      remotePath
      Path to the file on the server.
      localPath
      The path of the local file. This cannot be a directory.
      remoteOffset
      Restart marker from which the data transfer should start. The starting offset of the remote file.
      localOffset
      The starting offset in the local file.

      Return Value

      Number of bytes transfered.

      Remarks

      If the local file does not exist, it is created.

      Examples

      Shows how to use DownloadFile method to download a file on an SFTP server.

      using System.IO;
      using ComponentPro.Net;
      
      ...
      
      // Create a new class instance.
      Sftp client = new Sftp();
      
      // Connect to the SFTP server.
      client.Connect("localhost");
      
      // Authenticate.
      client.Authenticate("test", "test");
      
      // ... 
       
      // Download remote file '/test.dat' to 'c:\test.dat'
      client.DownloadFile("/test.dat", "c:\\test.dat", 1024, 1024);
      
      // ... 
       
      // 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