Cancel an operation

To abort a file transfer that is still in progress, you can either call the Cancel method or close the connection by calling the Disconnect or DisconnectAsync method.

The following code snippet shows how to use it.

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();
    }
}

Imports ComponentPro.IO
Imports ComponentPro.Net

...

Public Sub DoAbort()
    ' Create a new Sftp instance. 
    Dim client As New Sftp()

    ' Connect to the SFTP server. 
    client.Connect("demo.componentpro.com")

    ' Authenticate. 
    client.Authenticate("test", "test")

    Try 
        ' Register an event handler. 
        AddHandler client.Progress, AddressOf client_Progress

        ' Upload file "c:\test.zip". 
        client.UploadFile("c:\test.zip", "test.zip")
    Catch exc As SftpException
        Console.WriteLine("Exception: " & exc.Message)
    End Try 
 
    ' Disconnect. 
    client.Disconnect()
End Sub 
 
Private Sub client_Progress(ByVal sender As Object, ByVal e As FileSystemProgressEventArgs)
    ' Abort the uploading operation if the bytes transferred is greater than or equal to 500Kb. 
    If e.State = TransferState.Uploading AndAlso e.BytesTransferred >= 1024 * 500 Then 
        CType(sender, Sftp).Cancel()
    End If 
End Sub