ComponentPro UltimateSftp

      UploadAsync(String, Boolean, IEnumerable, String, TransferOptions) Method

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      Asynchronously uploads files from the specified local directory to the remote directory.

      Syntax

      public ExtendedAsyncResult<FileSystemTransferStatistics> UploadAsync(
         string localPath, 
         bool includeBaseDirectory, 
         IEnumerable localFilesToTransfer, 
         string remotePath, 
         TransferOptions options
      )

      Parameters

      localPath
      The path and name of the local directory where the files will be uploaded to the server. When the parameter localFilesToTransfer 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 "c:\mydir\*.dat;*.cs,*.vb" is used (masks are delimited by ',', ';', and '|' characters), files with the .DAT, .CS, or .VB extension in "c:\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: UploadAsync("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".
      localFilesToTransfer
      The list of files and directories to upload, or a null reference to upload files in the localPath that match the search condition specified in the options parameter. This can contain String and FileInfoBase objects. (e.g. UploadAsync(null, false, new string[] {@"d:\file1", @"c:\folder\file2", @"d:\dir1" }, ...) or UploadAsync(null, false, new object[] {@"d:\temp\file1", fileInfo1, fileInfo2 }, ...))
      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.

      Examples

      Shows how to use UploadAsync method to asynchronously upload files (Task-based approach).

      using System;
      using ComponentPro.IO;
      using ComponentPro.Net;
      using ComponentPro;
      
      ...
      
      // Create a new class instance.
      Sftp client = new Sftp();
      
      // Connect to the SFTP server.
      client.Connect("localhost");
      
      // Authenticate.
      client.Authenticate("test", "test");
      
      // ... 
       
      string[] filesAndFoldersToUpload = new string[]
                                                 {
                                                     "content1", // folder 
                                                     "content2", // folder 
                                                     "dir\\file1", // file 
                                                     "file2"       // file                                              
                                                 };
      
      // Upload selected files and subdirectories in local folder 'c:\temp' to the remote dir '/temp' 
      await client.UploadAsync("c:\\temp", false, filesAndFoldersToUpload, "/temp", new TransferOptions());
      
      // ... 
       
      // Disconnect.
      client.Disconnect();

      Shows how to use UploadAsync method to asynchronously upload files (Event-based approach).

      using System;
      using ComponentPro.IO;
      using ComponentPro.Net;
      using ComponentPro;
      
      ...
      
      private static void Main()
      {
          // Create a new class instance. 
          Sftp client = new Sftp();
      
          // Connect to the SFTP server. 
          client.Connect("localhost");
      
          // Authenticate. 
          client.Authenticate("test", "test");
      
          // ... 
       
          // Register an event handler. 
          client.UploadCompleted += client_UploadCompleted;
      
          string[] filesAndFoldersToUpload = new string[]
                                                     {
                                                         "content1", // folder 
                                                         "content2", // folder 
                                                         "dir\\file1", // file 
                                                         "file2"       // file                                              
                                                     };
      
          // Upload selected files and subdirectories in local folder 'c:\temp' to the remote dir '/temp' 
          client.UploadAsync("c:\\temp", false, filesAndFoldersToUpload, "/temp", new TransferOptions());
      
          // ... 
       
          // Disconnect. 
          client.Disconnect();
      }
      
      private static void client_UploadCompleted(object sender,
                                                      ExtendedAsyncCompletedEventArgs<FileSystemTransferStatistics> e)
      {
          // Sftp client = (Sftp)sender; 
          if (e.Error != null)
              Console.WriteLine("Error: " + e.Error.Message);
          else 
          {
              Console.WriteLine("Files uploaded: " + e.Result.FilesProcessed);
          }
      }

      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)

      See Also