Visual FoxPro

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 Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loSftp
LOCAL lnPort
LOCAL lcPassword

lnSuccess = 0

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

loSftp = CreateObject('Chilkat.SFtp')

*  Connect, authenticate, and initialize the SFTP subsystem.
lnPort = 22
lnSuccess = loSftp.Connect("sftp.example.com",lnPort)
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

*  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.
lcPassword = "mySshPassword"

lnSuccess = loSftp.AuthenticatePw("mySshLogin",lcPassword)
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

lnSuccess = loSftp.InitializeSftp()
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

*  Delete a remote file.
lnSuccess = loSftp.RemoveFile("subdir/obsolete.txt")
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
ENDIF

? "File removed."

loSftp.Disconnect()

RELEASE loSftp