JavaScript

Get a Remote FTP File's Size by Name

Demonstrates the Chilkat Ftp2.GetSizeByName method, which returns the size in bytes of a named file in the current remote directory as a 32-bit integer. The only argument is the filename — a name, not a path. It returns -1 when the file is not found or the size cannot be obtained.

Background: This is the direct way to get one file's size when you already know its name, typically via a SIZE command — no full directory listing required. Because the result is 32-bit, it cannot represent files past about 2 GB; use GetSizeStrByName for large files. The argument must be a bare filename in the current directory, so ChangeRemoteDir to the right place first.

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.GetSizeByName method, which returns the size in bytes of a named file in
//  the current remote directory as a 32-bit integer.  The only argument is the filename (a name,
//  not a path).

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

//  Returns -1 when the file is not found or the size cannot be obtained.  For files that may
//  exceed 2 GB, use GetSizeStrByName (returns a decimal string).
var fileSize = ftp.GetSizeByName("report.pdf");
if (fileSize < 0) {
    console.log("File not found, or size unavailable.");
    return;
}

console.log("report.pdf is " + fileSize + " bytes");

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