JavaScript

Get a Filename from an FTP Directory Listing

Demonstrates the Chilkat Ftp2.GetFilename method, which returns the name of a cached directory-listing entry. The only argument is a zero-based index from 0 through GetDirCount - 1.

Background: The Chilkat FTP directory API is index-based and works from a single cached listing: the first GetDirCount call fetches the current directory's listing once, and every indexed accessor — name, size, type, permissions, timestamps — then reads from that cache without further server round trips. That makes iterating a directory efficient, but it also means the data reflects the moment the listing was fetched; call ClearDirCache to force a refresh after the remote directory changes.

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.GetFilename method, which returns the name of a cached directory-listing
//  entry.  The only argument is a zero-based index from 0 through GetDirCount - 1.

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

//  GetDirCount retrieves the directory listing on the first call and returns the number of
//  entries.  A negative return indicates failure.
var n = ftp.GetDirCount();
if (n < 0) {
    console.log(ftp.LastErrorText);
    return;
}

var i;
for (i = 0; i <= n - 1; i++) {
    var name = ftp.GetFilename(i);
    console.log(name);
}

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