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.

var
success: Boolean;
sftp: HCkSFtp;
port: Integer;
password: PWideChar;
handle: PWideChar;
offset: Integer;

begin
success := False;

//  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 := CkSFtp_Create();

//  Connect, authenticate, and initialize the SFTP subsystem.
port := 22;
success := CkSFtp_Connect(sftp,'sftp.example.com',port);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

//  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 := CkSFtp_AuthenticatePw(sftp,'mySshLogin',password);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

success := CkSFtp_InitializeSftp(sftp);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

//  Open the remote file for read/write so an existing file can be modified in place.
handle := CkSFtp__openFile(sftp,'subdir/record.dat','readWrite','openOrCreate');
if (CkSFtp_getLastMethodSuccess(sftp) = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

//  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;
success := CkSFtp_WriteFileText32(sftp,handle,offset,'utf-8','HELLO');
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

success := CkSFtp_CloseHandle(sftp,handle);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;
Memo1.Lines.Add('Wrote at the specified offset.');

CkSFtp_Disconnect(sftp);

CkSFtp_Dispose(sftp);