ComponentPro UltimateFtp

      DeleteDirectory(String, Boolean) Method

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      Deletes the specified directory and, if indicated, any subdirectories and files in the directory.

      Syntax

      public FileSystemTransferStatistics DeleteDirectory(
         string directoryPath, 
         bool recursive
      )

      Parameters

      directoryPath
      The path and name of the directory to remove. This parameter can include filtering masks to limit the files that are deleted. For example, if ""(empty string) is specified, the entire contents of the current working folder will be deleted. If "*.txt" is used, all the files in the current working folder that have the .TXT extension will be deleted. 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 deleted. If no masks specified, the whole content of the specified directory should be deleted. Attention: some servers may be case-sensitive!
      recursive
      true to remove directories, subdirectories, and files in path; otherwise, false.

      Return Value

      The statistics of the multi-file operation.

      Remarks

      Empty directories are to be removed. This method does not build directory hierarchy before deleting items.

      For more advanced files and directories deletion, use the Delete methods.

      Examples

      FTP Examples

      The DeleteDirectory method is also used to delete a directory with contents

      using ComponentPro.IO;
      using ComponentPro.Net;
      
      ...
      
      using (Ftp ftp = new Ftp())
      {
          // Connect to the FTP server. 
          ftp.Connect("localhost");
          
          // Authenticate. 
          ftp.Authenticate("test", "test");
      
          // ... 
       
          // Delete an entire directory. 
          ftp.DeleteDirectory("/test", true);
      }

      SFTP Examples

      The DeleteDirectory method is also used to delete a directory with contents

      using ComponentPro.IO;
      using ComponentPro.Net;
      
      ...
      
      using (Sftp ftp = new Sftp())
      {
          // Connect to the SFTP server. 
          ftp.Connect("localhost");
          
          // Authenticate. 
          ftp.Authenticate("test", "test");
      
          // ... 
       
          // Delete an entire directory. 
          ftp.DeleteDirectory("/test", true);
      }

      ZIP Examples

      The DeleteDirectory method is also used to delete a directory with contents

      using ComponentPro.IO;
      using ComponentPro.Compression;
      
      ...
      
      using (Zip arc = new Zip())
      {
          // Open an existing archive. 
          zip.Open("test.zip");
      
          // ... 
       
          // Delete an entire directory. 
          zip.DeleteDirectory("/test", true);
      }

      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