ComponentPro UltimateFtp

      ListNameAsync(String, ExtendedAsyncCompletedEventHandler<String[]>, Object) Method

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      Begins an asynchronous ListName operation. Retrieves the list of file and directory names in the specified directory.

      Syntax

      public Task<string[]> ListNameAsync(
         string path, 
         ExtendedAsyncCompletedEventHandler<string[]> callback, 
         object userState = null
      )

      Parameters

      path
      The path of the directory, or null for current directory. If the file system is FTP, consider changing the current directory before listing because many FTP servers do not support LIST command with parameter.
      callback
      An optional asynchronous callback to be invoked when this operation completes. This parameter can be null.
      userState
      A user-provided object that identifies this particular asynchronous operation.

      Examples

      FTP Examples

      Shows how to use ListNameAsync method to asynchronously retrieve name list (Event-based approach).

      using System;
      using ComponentPro.IO;
      using ComponentPro.Net;
      using ComponentPro;
      
      ...
      
      static void Main()
      {
          // Create a new class instance. 
          Ftp client = new Ftp();
      
          client.ListNameCompleted += client_ListNameCompleted;
      
          // Connect to the FTP server. 
          client.Connect("myserver");
      
          // Authenticate. 
          client.Authenticate("test", "test");
      
          // ... 
       
          // Get names of all files and directories in '/' remote dir. 
          client.ListNameAsync("/");
      
          // ... 
       
          // Some FTP servers do not support ListName with parameter, we need to change directory before listing. 
          client.SetCurrentDirectory("/my folder");
          // Retrieve file list of the current directory - '/my folder' 
          client.ListNameAsync();
      
          // ... 
       
          // Disconnect. 
          client.Disconnect();
      }
      
      static void client_ListNameCompleted(object sender, ExtendedAsyncCompletedEventArgs<string[]> e)
      {
          // Ftp client = (Ftp)sender; 
          if (e.Error != null)
              Console.WriteLine("Error: " + e.Error.ToString());
          else 
              // Display the list. 
              foreach (string name in e.Result)
              {
                  Console.WriteLine("Name: {0}", name);
              }
      }

      SFTP Examples

      Shows how to use ListNameAsync method to asynchronously retrieve name list (Event-based approach).

      using System;
      using ComponentPro.IO;
      using ComponentPro.Net;
      using ComponentPro;
      
      ...
      
      static void Main()
      {
          // Create a new class instance. 
          Sftp client = new Sftp();
      
          client.ListNameCompleted += client_ListNameCompleted;
      
          // Connect to the SFTP server. 
          client.Connect("myserver");
      
          // Authenticate. 
          client.Authenticate("test", "test");
      
          // ... 
       
          // Get names of all files and directories in '/' remote dir. 
          client.ListNameAsync("/");
      
          // ... 
       
          // Some SFTP servers do not support ListName with parameter, we need to change directory before listing. 
          client.SetCurrentDirectory("/my folder");
          // Retrieve file list of the current directory - '/my folder' 
          client.ListNameAsync();
      
          // ... 
       
          // Disconnect. 
          client.Disconnect();
      }
      
      static void client_ListNameCompleted(object sender, ExtendedAsyncCompletedEventArgs<string[]> e)
      {
          // Sftp client = (Sftp)sender; 
          if (e.Error != null)
              Console.WriteLine("Error: " + e.Error.ToString());
          else 
              // Display the list. 
              foreach (string name in e.Result)
              {
                  Console.WriteLine("Name: {0}", name);
              }
      }

      Framework

      .NET Compact Framework.NET Compact Framework

      Supported version: 2.0, 3.5, and 3.9
      Assembly: ComponentPro.FileSystem.CF (in ComponentPro.FileSystem.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.FileSystem (in ComponentPro.FileSystem.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.FileSystem.WinPcl (in ComponentPro.FileSystem.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.FileSystem.Uwp (in ComponentPro.FileSystem.Uwp.dll)

      Xamarin AndroidXamarin Android

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

      Xamarin MacXamarin Mac

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

      Xamarin iOSXamarin iOS

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

      See Also