JavaScript

Download an FTP File as Text with a Charset

Demonstrates the Chilkat Ftp2.GetRemoteFileTextC method, which downloads a remote file, decodes the bytes using a named charset, and returns the text. The first argument is the remote filename and the second is the charset. A byte-order mark for the selected encoding is recognized and omitted.

Background: This is the encoding-aware way to read a remote text file: you name the charset (utf-8, iso-8859-1, and so on) so multibyte and accented characters decode correctly, and a leading BOM is stripped automatically. Prefer it over GetRemoteFileTextData whenever the file's encoding is known, which is almost always.

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.

JavaScript

var success = false;

//  Demonstrates the Ftp2.GetRemoteFileTextC method, which downloads a remote file, decodes the
//  bytes using a named charset, and returns the text.  The 1st argument is the remote filename
//  and the 2nd is the charset.

var ftp = new CkFtp2();

ftp.Hostname = "ftp.example.com";
ftp.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.
ftp.Password = "myPassword";

success = ftp.Connect();
if (success == false) {
    console.log(ftp.LastErrorText);
    return;
}

//  Download a UTF-8 text file.  A byte-order mark for the selected encoding is recognized and
//  omitted from the returned text.
var fileText = ftp.GetRemoteFileTextC("public_html/readme.txt","utf-8");
if (ftp.LastMethodSuccess == false) {
    console.log(ftp.LastErrorText);
    return;
}

console.log(fileText);

success = ftp.Disconnect();
if (success == false) {
    console.log(ftp.LastErrorText);
    return;
}