B4X

Rename or Move a Remote File or Directory

Demonstrates the Chilkat SFtp.RenameFileOrDir method, which renames or moves a remote file or directory. The first argument is the old path and the second is the new path.

Background: Rename and move are the same operation in SFTP: changing only the final path component renames in place, while changing the directory portion relocates the item. When source and destination are on the same filesystem the server does this as a fast metadata change rather than copying data, which is why moving even a large file is near-instant. Moving across filesystems, or onto an existing target, may fail depending on the server.

Chilkat B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  Demonstrates the SFtp.RenameFileOrDir method, which renames or moves a remote file or
'  directory.  The 1st argument is the old path and the 2nd is the new path.

Dim sftp As ChilkatSFtp
sftp.Initialize("sftp")

'  Connect, authenticate, and initialize the SFTP subsystem.
Dim port As Int = 22
success = sftp.Connect("sftp.example.com", port)
If success = False Then
    Log(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 = "mySshPassword"

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


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


'  Rename a file within the same directory.
success = sftp.RenameFileOrDir("subdir/report.txt", "subdir/report_final.txt")
If success = False Then
    Log(sftp.LastErrorText)
    Return
End If


'  Because rename can also move, the same method relocates an item to a different directory.
success = sftp.RenameFileOrDir("subdir/report_final.txt", "archive/report_final.txt")
If success = False Then
    Log(sftp.LastErrorText)
    Return
End If

Log("Renamed and moved.")

sftp.Disconnect