Get FTP Directory Listing Information

Ruby example showing how to get information about files and subdirectories in the current remote FTP directory.

Download Chilkat Ruby Library

require 'chilkat'

ftp = Chilkat::CkFtp2.new()

#  Any string unlocks the component for the 1st 30-days.
success = ftp.UnlockComponent("Anything for 30-day trial")
if (success != true)
    print ftp.lastErrorText() + "\n"
    exit
end

ftp.put_Hostname("www.example-code.com")
ftp.put_Username("****")
ftp.put_Password("****")

#  Connect and login to the FTP server.
success = ftp.Connect()
if (success != true)
    print ftp.lastErrorText() + "\n"
    exit
end

#  The ListPattern property is our directory listing filter.
#  The default value is "*", which includes everything.
print ftp.listPattern() + "\n";

#  To get file and sub-directory information, simply
#  loop from 0 to ftp.NumFilesAndDirs - 1

n = ftp.get_NumFilesAndDirs()
if (n < 0)
    print ftp.lastErrorText() + "\n"
    exit
end

if (n > 0)
    for i in 0 .. n - 1

        #  Display the filename
        print ftp.getFilename(i) + "\n";

        #  Display the file size (in bytes)
        print ftp.GetSize(i).to_s() + "\n";

        #  Is this a sub-directory?
        if (ftp.GetIsDirectory(i) == true)
            print ".. this is a sub-directory" + "\n";
        end

        print "--" + "\n";
    end
end

print "-----------------------------------" + "\n";

#  Changing the ListPattern automatically changes the value
#  of the NumFilesAndDirs property.  Only files and directories
#  matching the ListPattern are returned.
ftp.put_ListPattern("*.asp")
n = ftp.get_NumFilesAndDirs()
if (n < 0)
    print ftp.lastErrorText() + "\n"
    exit
end

if (n > 0)
    for i in 0 .. n - 1

        #  Display the filename
        print ftp.getFilename(i) + "\n";

        #  Display the file size (in bytes)
        print ftp.GetSize(i).to_s() + "\n";

        print "--" + "\n";
    end
end

ftp.Disconnect()