Cancels all the operations.

      Syntax

      public virtual bool Cancel()

      Examples

      FTP Examples

      Shows how to abort an operation using the Cancel method.

      using System;
      using ComponentPro.IO;
      using ComponentPro.Net;
      
      ...
      
      private static void Main()
      {
          // Create a new Ftp instance. 
          Ftp client = new Ftp();
      
          // Connect to the FTP server. 
          client.Connect("demo.componentpro.com");
      
          // Authenticate. 
          client.Authenticate("test", "test");
      
          try 
          {
              // Register an event handler. 
              client.Progress += client_Progress;
      
              // Upload file "c:\test.zip". 
              client.UploadFile("c:\\test.zip", "test.zip");
          }
          catch (FtpException exc)
          {
              Console.WriteLine("Exception: " + exc.Message);
          }
      
          // Disconnect. 
          client.Disconnect();
      }
      
      private static void client_Progress(object sender, FileSystemProgressEventArgs e)
      {
          // Abort the uploading operation if the bytes transferred is greater than or equal to 500Kb. 
          if (e.State == TransferState.Uploading && e.BytesTransferred >= 1024*500)
          {
              ((Ftp) sender).Cancel();
          }
      }

      SFTP Examples

      Shows how to abort an operation using the Cancel method.

      using System;
      using ComponentPro.IO;
      using ComponentPro.Net;
      
      ...
      
      public void DoAbort()
      {
          // Create a new Sftp instance. 
          Sftp client = new Sftp();
      
          // Connect to the SFTP server. 
          client.Connect("demo.componentpro.com");
      
          // Authenticate. 
          client.Authenticate("test", "test");
      
          try 
          {
              // Register an event handler. 
              client.Progress += client_Progress;
      
              // Upload file "c:\test.zip". 
              client.UploadFile("c:\\test.zip", "test.zip");
          }
          catch (SftpException exc)
          {
              Console.WriteLine("Exception: " + exc.Message);
          }
      
          // Disconnect. 
          client.Disconnect();
      }
      
      void client_Progress(object sender, FileSystemProgressEventArgs e)
      {
          // Abort the uploading operation if the bytes transferred is greater than or equal to 500Kb. 
          if (e.State == TransferState.Uploading && e.BytesTransferred >= 1024 * 500)
          {
              ((Sftp)sender).Cancel();
          }
      }

      ZIP Examples

      Shows how to abort an operation using the Cancel method.

      using System;
      using ComponentPro.IO;
      using ComponentPro.Compression;
      
      ...
      
      public void DoAbort()
      {
          // Create a new Zip instance. 
          Zip zip = new Zip();
      
          // Open an existing archive. 
          zip.Open("test.zip");
      
          try 
          {
              // Register an event handler. 
              zip.Progress += zip_Progress;
      
              // Add a file "c:\test.zip". 
              zip.AddFile("c:\\test.zip", "test.zip");
          }
          catch (ZipException exc)
          {
              Console.WriteLine("Exception: " + exc.Message);
          }
      
          // Close. 
          zip.Close();
      }
      
      void zip_Progress(object sender, FileSystemProgressEventArgs e)
      {
          // Abort the compressing operation if the bytes transferred is greater than or equal to 500Kb. 
          if (e.State == TransferState.Storing && e.BytesTransferred >= 1024 * 500)
          {
              ((Zip)sender).Cancel();
          }
      }

      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