ComponentPro UltimateSftp

      AuthenticateAsync(String, String) Method

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      Begins an asynchronous operation to authenticate the user to the FTP server.

      Syntax

      public ExtendedAsyncResult AuthenticateAsync(
         string userName, 
         string password
      )

      Parameters

      userName
      The username.
      password
      Password for the given username.

      Return Value

      An object that references the asynchronous operation.

      Examples

      Shows how to use ConnectAsync, AuthenticateAsync, and DisconnectAsync methods to asynchronously establish a connection and disconnect (Task-based approach).

      using System;
      using System.ComponentModel;
      using ComponentPro.IO;
      using ComponentPro.Net;
      using ComponentPro;
      
      ...
      
      // Create a new class instance.
      Sftp client = new Sftp();
      
      // Connect to the SFTP server asynchronously. 
      await client.ConnectAsync("myserver", 22);
      
      // ... 
       
      await client.AuthenticateAsync("userName", "password");
      
      // ...
      
      client.DownloadFile("/my remote file.dat", "my local file");
      
      // ... 
       
      await client.DisconnectAsync();

      Shows how to use ConnectAsync, AuthenticateAsync, and DisconnectAsync methods to asynchronously establish a connection and disconnect.

      using System;
      using System.ComponentModel;
      using ComponentPro.Net;
      
      ...
      
      static void Main()
      {
          // Create a new class instance. 
          Sftp client = new Sftp();
      
          client.ConnectCompleted += client_ConnectCompleted;
          client.AuthenticateCompleted += client_AuthenticateCompleted;
          client.DisconnectCompleted += client_DisconnectCompleted;
      
          // Connect to the SFTP server asynchronously. 
          client.ConnectAsync("myserver", 22);
      
          // Your code here 
          // ...
      }
      
      static void client_ConnectCompleted(object sender, AsyncCompletedEventArgs e)
      {
          Sftp client = (Sftp)sender;
          if (e.Error != null)
              Console.WriteLine("Error: " + e.Error.ToString());
          else 
          {
              // Authenticate the user asynchronously. 
              client.AuthenticateAsync("userName", "password");
          }
      }
      
      static void client_AuthenticateCompleted(object sender, AsyncCompletedEventArgs e)
      {
          Sftp client = (Sftp)sender;
      
          if (e.Error != null)
              Console.WriteLine("Error: " + e.Error.ToString());
          else 
          {
              // Do something here... 
              client.DownloadFile("/my remote file.dat", "my local file");
      
              // ... 
       
              // Disconnect asynchronously. 
              client.DisconnectAsync();
          }
      }
      
      static void client_DisconnectCompleted(object sender, AsyncCompletedEventArgs e)
      {
          // Sftp client = (Sftp)sender; 
          if (e.Error != null)
              Console.WriteLine("Error: " + e.Error.ToString());
      }

      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