Perl

Write Bytes to a Remote SFTP File (BinData)

Demonstrates the Chilkat SFtp.WriteFileBd method, which appends all bytes in a BinData to the remote file identified by an open handle. The first argument is the handle and the second is the BinData.

Note: This example uses a relative local path, which is resolved against the application's current working directory. Absolute local paths may also be used. Supply the path appropriate to your own environment.

Background: This is the binary counterpart to WriteFileText — the right choice for images, archives, or any non-text content, where a charset conversion would corrupt the data. Combined with an appropriate OpenFile disposition it can create, overwrite, or append; here the file is created/truncated first so the result is exactly the BinData contents.

Chilkat Perl Downloads

Download Chilkat for Perl

Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

# Demonstrates the SFtp.WriteFileBd method, which appends all bytes in a BinData to the remote
# file identified by an open handle.  The 1st argument is the handle and the 2nd is the BinData.

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 (creating/truncating) the remote file for writing.
my $handle = $sftp->OpenFile('subdir/image.png', 'writeOnly', 'createTruncate');
if (!$sftp->LastMethodSuccess) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# Put the bytes to write into a BinData.  (Here they are loaded from a local file, but the
# bytes could come from anywhere.)
my $bd = Chilkat2::BinData->new;
$success = $bd->LoadFile('qa_data/image.png');
if (!$success) {
    print $bd->LastErrorText, "\n";
    exit;
}

# Append the BinData bytes to the open remote file.
$success = $sftp->WriteFileBd($handle, $bd);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

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

print 'Wrote ', $bd->NumBytes, " bytes.\n";

$sftp->Disconnect();