Pascal (Lazarus/Delphi)

SFTP Get Size of File on Server

See more SFTP Examples

Demonstrates how to get the size of an existing file on the server. Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.SFtp;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  sftp: TSFtp;
  hostname: string;
  port: Integer;
  bFollowLinks: Boolean;
  bIsHandle: Boolean;
  fileSize: Integer;
  fileSizeStr: string;
  handle: string;

begin
  success := False;

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

  sftp := TSFtp.Create;

  //  Set some timeouts, in milliseconds:
  sftp.ConnectTimeoutMs := 5000;
  sftp.IdleTimeoutMs := 10000;

  //  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 := sftp.Connect(hostname,port);
  if (success <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      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 := sftp.AuthenticatePw('myLogin','myPassword');
  if (success <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  After authenticating, the SFTP subsystem must be initialized:
  success := sftp.InitializeSftp();
  if (success <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  Assuming we know the file size won't be too large, we get the size as a 32-bit integer.
  //  For SFTP, the remote file path is always either a path relative to the HOME directory of the user account, or an absolute path on the server.
  bFollowLinks := True;
  bIsHandle := False;
  fileSize := sftp.GetFileSize32('someDir/someFile.dat',bFollowLinks,bIsHandle);
  if (fileSize < 0) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;
  WriteLn('file size = ' + fileSize);

  //  If the file size might be too large for a 32-bit signed integer, then get the size as a decimal string.
  //  You can convert the string to a 64-bit integer in your programming language.
  fileSizeStr := sftp.GetFileSizeStr('someDir/someFile.dat',bFollowLinks,bIsHandle);
  if (sftp.LastMethodSuccess = False) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;
  WriteLn('file size = ' + fileSizeStr);

  //  You can alternatively get the size with an open file handle.
  handle := sftp.OpenFile('someDir/someFile.dat','readOnly','openExisting');
  if (sftp.LastMethodSuccess <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  Get the size using the handle.
  bIsHandle := True;
  fileSize := sftp.GetFileSize32('someDir/someFile.dat',bFollowLinks,bIsHandle);
  if (fileSize < 0) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;
  WriteLn('file size = ' + fileSize);

  //  -----------------------------------------------------------------------------
  //  Don't forget to close the file handle.
  //  Otherwise open handles will accumulate on the server until eventually a limit
  //  is reached and the server will fail on a call to OpenFile.
  //  -----------------------------------------------------------------------------

  //  Close the file.
  success := sftp.CloseHandle(handle);
  if (success <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;


  sftp.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.