Get a Remote File's Size as a String

See more SFTP Examples

Demonstrates the Chilkat SFtp.GetFileSizeStr method, which returns a remote file's size in bytes as a decimal string. The arguments are the remote path (or handle), whether symbolic links are followed, and whether the first argument is a handle.

import 'package:chilkat/chilkat.dart';

void main() {
  // Demonstrates the SFtp.GetFileSizeStr method, which returns a remote file's size in bytes as a
  // decimal string.  The 1st argument is the remote path (or handle), the 2nd selects whether
  // symbolic links are followed, and the 3rd indicates whether the 1st argument is a handle.

  final sftp = CkSFtp();

  // Connect, authenticate, and initialize the SFTP subsystem.
  final port = 22;
  try {
    sftp.connect('sftp.example.com', port);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // 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.
  final password = 'mySshPassword';

  try {
    sftp.authenticatePw('mySshLogin', password);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    sftp.initializeSftp();
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // The 2nd argument (bFollowLinks) selects whether a symbolic link is followed to its target.
  // The 3rd argument (bIsHandle) is false here because the 1st argument is a path, not an
  // open handle.
  final bFollowLinks = true;
  final bIsHandle = false;

  // A string return avoids the 32-bit overflow that GetFileSize32 would have for very large files.
  final String fileSize;
  try {
    fileSize = sftp.getFileSizeStr('subdir/hugefile.dat', bFollowLinks, bIsHandle);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('File size: $fileSize bytes');

  sftp.disconnect();
}