Ruby

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.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

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.

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

#  GetDirCount retrieves the directory listing on the first call and returns the number of
#  entries.  A negative return indicates failure.
n = ftp.GetDirCount()
if (n < 0)
    print ftp.lastErrorText() + "\n";
    exit
end

for i in 0 .. n - 1
    name = ftp.getFilename(i)
    print name + "\n";
end

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