JavaScript

Get FTP Filenames as XML (NLST)

Demonstrates the Chilkat Ftp2.NlstXml method, which sends NLST and returns the matching names in XML form. The only argument is appended literally; an empty string sends a bare NLST and a value like *.txt sends NLST *.txt.

Tip: Code to parse the returned XML can be generated at Chilkat Tools.

Background: NLST is the lightweight listing command: it returns only names, with none of the sizes, dates, or type information that LIST provides. That makes it fast and simple when a bare list of filenames is all you need — for example to drive a batch of downloads. Wrapping the result as XML gives you a clean, uniform structure to iterate regardless of how the server formats the raw NLST reply.

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.NlstXml method, which sends NLST and returns the matching names in XML
//  form.  The only argument is appended literally; an empty string sends a bare NLST.

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

success = ftp.ChangeRemoteDir("public_html");
if (success == false) {
    console.log(ftp.LastErrorText);
    return;
}

//  NLST returns names only (no sizes, dates, or types).  "*.txt" sends NLST *.txt.
var xml = ftp.NlstXml("*.txt");
if (ftp.LastMethodSuccess == false) {
    console.log(ftp.LastErrorText);
    return;
}

console.log(xml);

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