Perl

Open a Remote Directory on an SFTP Server

Demonstrates the Chilkat SFtp.OpenDir method, which opens a remote directory and returns a handle for reading its entries. The only argument is the directory path. Close the handle with CloseHandle when finished.

Background: Listing a directory in SFTP is a handle-based operation, mirroring file access: open the directory to get a handle, read its entries, then close it. The handle is passed to ReadDirListing to retrieve the names and attributes. As with file handles, the directory handle is a server-side resource that should be closed to avoid exhausting the server's limits.

Chilkat Perl Downloads

Download Chilkat for Perl

Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

# Demonstrates the SFtp.OpenDir method, which opens a remote directory and returns a handle for
# reading its entries.  The only argument is the directory path.

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

# Connect, authenticate, and initialize the SFTP subsystem.
my $port = 22;
my $success = $sftp->Connect('sftp.example.com', $port);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# 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.
my $password = 'mySshPassword';

$success = $sftp->AuthenticatePw('mySshLogin', $password);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

$success = $sftp->InitializeSftp();
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# Open the remote directory.  OpenDir returns a handle string.
my $handle = $sftp->OpenDir('subdir');
if (!$sftp->LastMethodSuccess) {
    print $sftp->LastErrorText, "\n";
    exit;
}

print 'Opened directory, handle = ', $handle, "\n";

# The directory entries are read with ReadDirListing using this handle.

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

$sftp->Disconnect();