Ruby

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.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

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).

ftp = Chilkat::CkFtp2.new()

ftp.put_Hostname("ftp.example.com")
ftp.put_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.put_Password("myPassword")

success = ftp.Connect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

success = ftp.ChangeRemoteDir("public_html")
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

#  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).
fileSize = ftp.GetSizeByName("report.pdf")
if (fileSize < 0)
    print "File not found, or size unavailable." + "\n";
    exit
end

print "report.pdf is " + fileSize.to_s() + " bytes" + "\n";

success = ftp.Disconnect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end