Perl

SFTP Read Text File

See more SFTP Examples

Demonstrates how to open a text file on the SSH server and read text. Perl

use chilkat();

$success = 0;

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

$sftp = chilkat::CkSFtp->new();

# Set some timeouts, in milliseconds:
$sftp->put_ConnectTimeoutMs(5000);
$sftp->put_IdleTimeoutMs(15000);

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
$hostname = "sftp.example.com";
$port = 22;
$success = $sftp->Connect($hostname,$port);
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\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 != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

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

# Open a file for reading.

$handle = $sftp->openFile("myTest.txt","readOnly","openExisting");
if ($sftp->get_LastMethodSuccess() != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# Assume the file we are reading contains the following text:
# abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
# (in ANSI format -- i.e. one byte per char).

# Read 26 bytes:

$sText = $sftp->readFileText($handle,26,"ansi");
if ($sftp->get_LastMethodSuccess() != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# Should print "abcdefghijklmnopqrstuvwxyz"
print $sText . "\r\n";

# Read the next 10 bytes.
$sText = $sftp->readFileText($handle,10,"ansi");
if ($sftp->get_LastMethodSuccess() != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# Should print "1234567890"
print $sText . "\r\n";

# Read the next 26 bytes.
$sText = $sftp->readFileText($handle,26,"ansi");
if ($sftp->get_LastMethodSuccess() != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
print $sText . "\r\n";

# Close the file.
$success = $sftp->CloseHandle($handle);
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

print "Success." . "\r\n";