ComponentPro UltimateSftp

      Upload(FileSystem, String, Boolean, IEnumerable, String, TransferOptions, Int32, Boolean) Method

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      Uploads files from the specified source directory on the specified source file system to the specified remote directory using multiple threads.

      Syntax

      public FileSystemTransferStatistics Upload(
         FileSystem sourceFileSystem, 
         string sourcePath, 
         bool includeBaseDirectory, 
         IEnumerable sourceFilesToTransfer, 
         string remotePath, 
         TransferOptions options, 
         int threads, 
         bool waitForThreads
      )

      Parameters

      sourceFileSystem
      The source file system containing files to upload.
      sourcePath
      The path and name of the directory on the source file system where the files will be uploaded to the server. When the parameter sourceFilesToTransfer is a null reference, this parameter can include filtering masks to limit the files that are uploaded. For example, if ""(empty string) is specified, the entire contents of the current folder will be uploaded. If "*.txt" is used, all the files in the current folder that have the .TXT extension will be uploaded. If "/mydir/*.dat;*.cs,*.vb" is used (masks are delimited by ',', ';', and '|' characters), files with the DAT, CS, or VB extension in "/mydir" will be uploaded. If no masks specified, the whole content of the local directory should be uploaded. The final search condition depends on the SearchCondition and SearchConditionCombinedWithMasksInSourcePath settings of the options parameter. Attention: some servers may be case-sensitive!
      includeBaseDirectory
      Indicates whether the containing directory should also be created in the destination directory. For example: Upload(zipSystem, "MyDir/*.txt", true, null, "/RemoteDir" ...) - if this parameter is true, "MyDir" is created in "RemoteDir" and all files and dirs within "MyDir" are copied to "RemoteDir/MyDir"; otherwise false, "MyDir" is not created in "RemoteDir", only files and subdirectories within "MyDir" are copied to "RemoteDir".
      sourceFilesToTransfer
      The list of files and directories to upload, or a null reference to upload files in the sourcePath that match the search condition specified in the options parameter. This list can contain String and FileInfoBase objects. (e.g. Upload(zipSystem, "", false, new string[] {"/dir/file1", "file2", "dir1" }...) or Upload(zipSystem, "", false, new object[] {"/dir/file1", fileInfo2, dirInfo1 }...))
      remotePath
      The path of the remote directory to store uploaded files.
      options
      The transfer options object which provides many settings to control the file transfer process.
      threads
      The number of threads used for the simultaneous file transfer.
      waitForThreads
      A boolean value indicating whether to wait for the completion of all threads. If this parameter is true, this method blocks the caller process's execution until all threads have completed; otherwise, this method immediately returns the control to the caller process.

      Return Value

      A FileSystemTransferStatistics object that contains transfer statictics and a list of processed files and directories.

      Examples

      Use 50 threads to upload files simultaneously from another SFTP server.

      using System;
      using ComponentPro.IO;
      using ComponentPro.Net;
      
      ...
      
      using (Sftp firstSftp = new Sftp())
      {
          // Connect to the SFTP server. 
          firstSftp.Connect("localhost");
      
          // Authenticate. 
          firstSftp.Authenticate("test", "test");
      
          // Create the second Sftp instance. 
          Sftp ftp2 = new Sftp();
          ftp2.Connect("mysecondserver");
      
          // Authenticate. 
          ftp2.Authenticate("test", "test");
      
          firstSftp.Upload(ftp2, // The second SFTP file system 
              "/data", // The remote directory on the 2nd SFTP server. 
              false, // The base directory is not include - only files and subdirectories in "/data" will be copied. 
              null,
              "/dest", // The remote directory on the 1st SFTP server. 
              new TransferOptions(),
              50, // Use 50 threads 
              true // Wait until all the threads complete. 
              );
      
          // Upload DAT and DOC files only. 
          firstSftp.Upload(ftp2, // The second SFTP file system 
              "/data/*.dat;*.doc", // The remote directory on the 2nd SFTP server. 
              false, // The base directory is not include - only files and subdirectories in "/data" will be copied. 
              null,
              "/dest", // The remote directory on the 1st SFTP server. 
              new TransferOptions(),
              50, // Use 50 threads 
              true // Wait until all the threads complete. 
              );
      
          ftp2.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