Xojo Plugin

Delete a Remote File on an SFTP Server

Demonstrates the Chilkat SFtp.RemoveFile method, which deletes a remote file. The only argument is the file path.

Background: Deletion is immediate and permanent — SFTP has no trash or undo — so a job that removes files should be certain of the path first. Whether deletion is even allowed depends on the account's permissions on the file and its containing directory, since on Unix-like systems the right to remove a file comes from write permission on the directory, not the file itself.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the SFtp.RemoveFile method, which deletes a remote file.  The only argument is
//  the file path.

Dim sftp As New Chilkat.SFtp

//  Connect, authenticate, and initialize the SFTP subsystem.
Dim port As Int32
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
Dim password As String
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

success = sftp.InitializeSftp()
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  Delete a remote file.
success = sftp.RemoveFile("subdir/obsolete.txt")
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("File removed.")

sftp.Disconnect