Xbase++

Rename or Move a Remote FTP File

Demonstrates the Chilkat Ftp2.RenameRemoteFile method, which renames or moves a remote file or directory using the FTP RNFR/RNTO sequence. The first argument is the existing path and the second is the new path.

Background: Rename and move are the same RNFR/RNTO operation: changing only the final path component renames in place, while including directory components in the new path relocates the item within the same server. It is a metadata operation, so even a large file moves instantly — but both paths must be on the same server, and moving onto an existing target may fail depending on the server.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oFtp

nSuccess := 0

//  Demonstrates the Ftp2.RenameRemoteFile method, which renames or moves a remote file or
//  directory using the FTP RNFR/RNTO sequence.  The 1st argument is the existing path and the 2nd
//  is the new path.

oFtp := CreateObject("Chilkat.Ftp2")

oFtp:Hostname := "ftp.example.com"
oFtp:Username := "myFtpLogin"

//  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.
oFtp:Password := "myPassword"

nSuccess := oFtp:Connect()
IF (nSuccess == 0)
    ? oFtp:LastErrorText
    oFtp:destroy()
    RETURN
ENDIF

nSuccess := oFtp:ChangeRemoteDir("public_html")
IF (nSuccess == 0)
    ? oFtp:LastErrorText
    oFtp:destroy()
    RETURN
ENDIF

//  Rename a file in place.
nSuccess := oFtp:RenameRemoteFile("report.pdf", "report_final.pdf")
IF (nSuccess == 0)
    ? oFtp:LastErrorText
    oFtp:destroy()
    RETURN
ENDIF

//  Include directory components in the new path to move the item within the same server.
nSuccess := oFtp:RenameRemoteFile("report_final.pdf", "archive/report_final.pdf")
IF (nSuccess == 0)
    ? oFtp:LastErrorText
    oFtp:destroy()
    RETURN
ENDIF

? "Renamed and moved."

nSuccess := oFtp:Disconnect()
IF (nSuccess == 0)
    ? oFtp:LastErrorText
    oFtp:destroy()
    RETURN
ENDIF

oFtp:destroy()