Perl Requires Chilkat v11.0.0+

SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files. Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

# This requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# Important: It is helpful to send the contents of the
# sftp.LastErrorText property when requesting support.

my $sftp = Chilkat2::SFtp->new;

# Set some timeouts, in milliseconds:
$sftp->ConnectTimeoutMs(5000);
$sftp->IdleTimeoutMs(10000);

# Connect to the SSH server.
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
my $hostname = 'www.my-sftp-server.com';
my $port = 22;
my $success = $sftp->Connect($hostname, $port);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
$success = $sftp->AuthenticatePw('myLogin', 'myPassword');
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# After authenticating, the SFTP subsystem must be initialized:
$success = $sftp->InitializeSftp();
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# Open a directory on the server...
# Paths starting with a slash are "absolute", and are relative
# to the root of the file system. Names starting with any other
# character are relative to the user's default directory (home directory).
# A path component of ".." refers to the parent directory,
# and "." refers to the current directory.
my $handle = $sftp->OpenDir('.');
if (!$sftp->LastMethodSuccess) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# Download the directory listing:

my $dirListing = Chilkat2::SFtpDir->new;
$success = $sftp->ReadDirListing($handle, $dirListing);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# Close the handle for the directory listing.
$success = $sftp->CloseHandle($handle);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# Iterate over the files.
my $fileObj = Chilkat2::SFtpFile->new;
my $i = 0;
my $n = $dirListing->NumFilesAndDirs;
while ($i < $n) {
    $success = $dirListing->FileAt($i, $fileObj);
    if (!$success) {
        print $dirListing->LastErrorText, "\n";
        exit;
    }

    print $fileObj->Filename, "\n";
    print $fileObj->FileType, "\n";
    print 'Size in bytes: ', $fileObj->Size32, "\n";
    print "----\n";

    $i = $i + 1;
}

print "Success.\n";