Write Text at a 32-bit Offset in a Remote SFTP File

See more SFTP Examples

Demonstrates the Chilkat SFtp.WriteFileText32 method, which encodes text and writes it at a specific 32-bit byte offset in an open handle. The arguments are the handle, the offset, the charset, and the text.

<?php

use Chilkat2\SFtp;

// Demonstrates the SFtp.WriteFileText32 method, which encodes text and writes it at a specific
// 32-bit byte offset in an open handle.  The 1st argument is the handle, the 2nd is the offset,
// the 3rd is the charset, and the 4th is the text.

$sftp = new SFtp();

// Connect, authenticate, and initialize the SFTP subsystem.
$port = 22;
try {
    $sftp->Connect('sftp.example.com', $port);

    // 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';

    $sftp->AuthenticatePw('mySshLogin', $password);

    $sftp->InitializeSftp();

    // Open the remote file for read/write so an existing file can be modified in place.
    $handle = $sftp->OpenFile('subdir/record.dat', 'readWrite', 'openOrCreate');

    // Overwrite 5 bytes starting at offset 10.  The offset is a byte position, not a character
    // position, so it must account for the encoded size of any multibyte characters.
    $offset = 10;
    $sftp->WriteFileText32($handle, $offset, 'utf-8', 'HELLO');

    $sftp->CloseHandle($handle);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Wrote at the specified offset.\n";

$sftp->Disconnect();