(JavaScript) SFTP Delete File

Demonstrates how to delete a file on the remote SFTP server.

IMPORTANT: See Understanding SFTP Absolute FilePaths

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

var sftp = new CkSFtp();

// Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 5000;
sftp.IdleTimeoutMs = 10000;

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
var hostname = "sftp.example.com";
var port = 22;
success = sftp.Connect(hostname,port);
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

// Authenticate with the SSH server.  Chilkat SFTP supports
// both password-based authenication as well as public-key
// authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword");
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

// After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp();
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

// Delete a file on the server:

success = sftp.RemoveFile("hamlet.xml");
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("File Deleted!");