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

Perl

use chilkat();

$success = 0;

#  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.

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

#  Connect, authenticate, and initialize the SFTP subsystem.
$port = 22;
$success = $sftp->Connect("sftp.example.com",$port);
if ($success == 0) {
    print $sftp->lastErrorText() . "\r\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.
$password = "mySshPassword";

$success = $sftp->AuthenticatePw("mySshLogin",$password);
if ($success == 0) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

$success = $sftp->InitializeSftp();
if ($success == 0) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

#  Open (creating/truncating) the remote file for writing.
$handle = $sftp->openFile("subdir/image.png","writeOnly","createTruncate");
if ($sftp->get_LastMethodSuccess() == 0) {
    print $sftp->lastErrorText() . "\r\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.)
$bd = chilkat::CkBinData->new();
$success = $bd->LoadFile("qa_data/image.png");
if ($success == 0) {
    print $bd->lastErrorText() . "\r\n";
    exit;
}

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

$success = $sftp->CloseHandle($handle);
if ($success == 0) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

print "Wrote " . $bd->get_NumBytes() . " bytes." . "\r\n";

$sftp->Disconnect();