Tcl

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 Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

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

set sftp [new_CkSFtp]

#  Connect, authenticate, and initialize the SFTP subsystem.
set port 22
set success [CkSFtp_Connect $sftp "sftp.example.com" $port]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

#  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.
set password "mySshPassword"

set success [CkSFtp_AuthenticatePw $sftp "mySshLogin" $password]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

set success [CkSFtp_InitializeSftp $sftp]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

#  Delete a remote file.
set success [CkSFtp_RemoveFile $sftp "subdir/obsolete.txt"]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

puts "File removed."

CkSFtp_Disconnect $sftp

delete_CkSFtp $sftp