(Delphi DLL) SFTP Read Text File to String

Demonstrates how to download a text file from an SSH server directly into a string variable.

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, SFtp;

...

procedure TForm1.Button1Click(Sender: TObject);
var
sftp: HCkSFtp;
hostname: PWideChar;
port: Integer;
success: Boolean;
handle: PWideChar;
bFollowLinks: Boolean;
bIsHandle: Boolean;
numBytes: Integer;
charset: PWideChar;
fileContents: PWideChar;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

sftp := CkSFtp_Create();

// Set some timeouts, in milliseconds:
CkSFtp_putConnectTimeoutMs(sftp,5000);
CkSFtp_putIdleTimeoutMs(sftp,15000);

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
hostname := 'sftp.example.com';
port := 22;
success := CkSFtp_Connect(sftp,hostname,port);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Authenticate with the SSH server.  Chilkat SFTP supports
// both password-based authenication as well as public-key
// authentication.  This example uses password authenication.
success := CkSFtp_AuthenticatePw(sftp,'myLogin','myPassword');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// After authenticating, the SFTP subsystem must be initialized:
success := CkSFtp_InitializeSftp(sftp);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Open a file on the server:

handle := CkSFtp__openFile(sftp,'hamlet.xml','readOnly','openExisting');
if (CkSFtp_getLastMethodSuccess(sftp) <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Get the total size of this file (in bytes)
bFollowLinks := False;
bIsHandle := True;

// bFollowLinks is ignored because we are passing a handle
// and not a remote filename.
// There are alternative methods for handling file sizes
// greater than 32-bit.  (See the reference documentation.)
numBytes := CkSFtp_GetFileSize32(sftp,handle,bFollowLinks,bIsHandle);
if (numBytes < 0) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// The charset indicates the character encoding of the text
// file on the SSH server.   Setting the charset correctly
// allows the Chilkat SFTP component to correctly interpret
// the bytes that represent the characters.

charset := 'ansi';

fileContents := CkSFtp__readFileText(sftp,handle,numBytes,charset);
if (CkSFtp_getLastMethodSuccess(sftp) <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end
else
  begin
    Memo1.Lines.Add('Received file:');
    Memo1.Lines.Add(fileContents);
  end;

// Close the file.
success := CkSFtp_CloseHandle(sftp,handle);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

Memo1.Lines.Add('Success.');

CkSFtp_Dispose(sftp);

end;