Delphi ActiveX

Check Whether the Last SFTP Read Failed

Demonstrates the Chilkat SFtp.LastReadFailed method, which returns whether the most recent read for a handle failed. The only argument is the handle. A normal end-of-file is not a failure.

Background: A chunked read loop needs to tell three outcomes apart: more data, a clean end-of-file, and an actual error such as a dropped connection or a revoked handle. LastReadFailed isolates the error case — it is false on a normal EOF read (which succeeds with zero bytes) and true for an empty, malformed, or already-closed handle — so the loop can stop cleanly on EOF but bail out with an error message on a genuine failure.

Chilkat Delphi ActiveX Downloads

Download Chilkat for Delphi ActiveX

Delphi ActiveX

var
success: Integer;
sftp: TChilkatSFtp;
port: Integer;
password: WideString;
handle: WideString;
reading: Integer;
chunkSize: Integer;
bd: TChilkatBinData;

begin
success := 0;

//  Demonstrates the SFtp.LastReadFailed method, which returns whether the most recent read for a
//  handle failed.  The only argument is the handle.  A normal end-of-file is NOT a failure.

sftp := TChilkatSFtp.Create(Self);

//  Connect, authenticate, and initialize the SFTP subsystem.
port := 22;
success := sftp.Connect('sftp.example.com',port);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    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 := sftp.AuthenticatePw('mySshLogin',password);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

success := sftp.InitializeSftp();
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

handle := sftp.OpenFile('subdir/data.txt','readOnly','openExisting');
if (sftp.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

reading := 1;
chunkSize := 4096;
bd := TChilkatBinData.Create(Self);
while reading do
  begin
    success := sftp.ReadFileBd(handle,chunkSize,bd.ControlInterface);

    //  Distinguish an actual read failure from a normal EOF.  On EOF the read succeeds, returns
    //  zero bytes, and LastReadFailed is 0.
    if (sftp.LastReadFailed(handle)) then
      begin
        Memo1.Lines.Add('Read failed: ' + sftp.LastErrorText);
        Exit;
      end;

    reading := not sftp.Eof(handle);
  end;

success := sftp.CloseHandle(handle);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;
Memo1.Lines.Add('Read ' + IntToStr(bd.NumBytes) + ' bytes with no read failures.');

sftp.Disconnect();