JavaScript

Get a Directory Listing as XML

Demonstrates the Chilkat Ftp2.GetXmlDirListing method, which retrieves a directory listing and returns the parsed entries as an XML document rooted at <remoteDir>, with a <file> element per entry. The only argument is the listing pattern; an empty string lists the current directory.

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

Background: This is the parse-friendly listing: Chilkat has already interpreted the server's raw LIST output — whatever its format — into consistent XML with names, sizes, dates, and types as elements. That spares you from writing format-specific parsers and is the right choice when a program, rather than a person, consumes the listing. Load the result into a Chilkat.Xml object to iterate the entries.

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.GetXmlDirListing method, which returns a directory listing as a parsed
//  XML document.  The only argument is the listing pattern; an empty string lists the current
//  remote directory.

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

//  The XML is rooted at <remoteDir>, with <file> elements for each entry.  This is easier to
//  parse programmatically than the raw text listing.
var xml = ftp.GetXmlDirListing("*.html");
if (ftp.LastMethodSuccess == false) {
    console.log(ftp.LastErrorText);
    return;
}

console.log(xml);

//  The XML can be loaded into a Chilkat.Xml object for further processing.

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