Delphi DLL

Upload Text to an SFTP Server (StringBuilder)

Demonstrates the Chilkat SFtp.UploadSb method, which encodes the text in a StringBuilder and uploads it to a remote file. The arguments are the StringBuilder, the remote file path, the charset, and whether to prepend a byte-order mark.

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

Background: This is the text-oriented upload: you assemble a document — a CSV, a config file, JSON — in a StringBuilder and the method handles character encoding as it writes. The charset controls the bytes actually stored (for example utf-8 or iso-8859-1), and the byte-order-mark flag is useful when a consuming Windows application expects a BOM. An existing destination is truncated first.

Chilkat Delphi DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

var
success: Boolean;
sftp: HCkSFtp;
port: Integer;
password: PWideChar;
sb: HCkStringBuilder;
includeBom: Boolean;

begin
success := False;

//  Demonstrates the SFtp.UploadSb method, which encodes the text in a StringBuilder and uploads
//  it to a remote file.  The 1st argument is the StringBuilder, the 2nd is the remote file path,
//  the 3rd is the charset, and the 4th selects whether a byte-order mark is prepended.

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;

//  Build the text to upload.
sb := CkStringBuilder_Create();
CkStringBuilder_Append(sb,'name,quantity' + #10);
CkStringBuilder_Append(sb,'widgets,42' + #10);
CkStringBuilder_Append(sb,'gadgets,17' + #10);

//  Upload as UTF-8 without a byte-order mark.  If the remote file exists, it is truncated first.
includeBom := False;
success := CkSFtp_UploadSb(sftp,sb,'subdir/inventory.csv','utf-8',includeBom);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;
Memo1.Lines.Add('Uploaded text file.');

CkSFtp_Disconnect(sftp);

CkSFtp_Dispose(sftp);
CkStringBuilder_Dispose(sb);