ComponentPro UltimateSftp

      ListName(String, SearchCondition) Method

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      Gets the list of file and directory names in the specified remote directory.

      Syntax

      public override string[] ListName(
         string path, 
         SearchCondition searchCondition
      )

      Parameters

      path
      Absolute or relative path to the remote directory to list, or null reference (Nothing in VB.NET). File wildcards masks (such as *.txt) are accepted.
      searchCondition
      The search conditions to match against the files, or null reference (Nothing in VB.NET) for searching all files.

      Return Value

      An array of lines, with each line representing a single name.

      Examples

      Shows how to use ListName methods to retrieve names of files and subdirectories in a directory.

      using System;
      using ComponentPro.Net;
      
      ...
      
      // Create a new class instance.
      Sftp client = new Sftp();
      
      // Connect to the SSFTP server.
      client.Connect("myserver");
      
      // Authenticate.
      client.Authenticate("test", "test");
      
      // ... 
       
      // Get names of all files and directories in '/' remote dir. 
      foreach (string name in client.ListName("/"))
      {
          Console.WriteLine("Name: {0}", name);
      }
      
      // Change the current directory to "/my folder".
      client.SetCurrentDirectory("/my folder");
      // Get names of all files and directories in the current remote dir. 
      foreach (string name in client.ListName())
      {
          Console.WriteLine("Name: {0}", name);
      }
      
      // ... 
       
      // 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