Delphi DLL

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 Delphi DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

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

begin
success := False;

//  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 := 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 (creating/truncating) the remote file for writing.
handle := CkSFtp__openFile(sftp,'subdir/image.png','writeOnly','createTruncate');
if (CkSFtp_getLastMethodSuccess(sftp) = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

//  Put the bytes to write into a BinData.  (Here they are loaded from a local file, but the
//  bytes could come from anywhere.)
bd := CkBinData_Create();
success := CkBinData_LoadFile(bd,'qa_data/image.png');
if (success = False) then
  begin
    Memo1.Lines.Add(CkBinData__lastErrorText(bd));
    Exit;
  end;

//  Append the BinData bytes to the open remote file.
success := CkSFtp_WriteFileBd(sftp,handle,bd);
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 ' + IntToStr(CkBinData_getNumBytes(bd)) + ' bytes.');

CkSFtp_Disconnect(sftp);

CkSFtp_Dispose(sftp);
CkBinData_Dispose(bd);