JavaScript

SFTP Write Text File

See more SFTP Examples

Demonstrates how to create a new text file on the remote SSH server, append text by calling WriteFileText one or more times, and then close the file. JavaScript

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 = 15000;

// 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;
}

// Open a file on the server for writing.
// "createTruncate" means that a new file is created; if the file already exists, it is opened and truncated. 
var handle = sftp.OpenFile("myTest.txt","writeOnly","createTruncate");
if (sftp.LastMethodSuccess !== true) {
    console.log(sftp.LastErrorText);
    return;
}

// Write some text to the file:
success = sftp.WriteFileText(handle,"ansi","abcdefghijklmnopqrstuvwxyz");
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

success = sftp.WriteFileText(handle,"ansi","1234567890");
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

success = sftp.WriteFileText(handle,"ansi","ABCDEFGHIJKLMNOPQRSTUVWXYZ");
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

// Close the file.
success = sftp.CloseHandle(handle);
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("Success.");