Dart

SFTP Get Size of File on Server

See more SFTP Examples

Demonstrates how to get the size of an existing file on the server. Dart

import 'package:chilkat/chilkat.dart';

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

  final sftp = CkSFtp();

  // 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.
  final hostname = 'sftp.example.com';
  final port = 22;
  try {
    sftp.connect(hostname, port);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Authenticate with the SSH server.  Chilkat SFTP supports
  // both password-based authenication as well as public-key
  // authentication.  This example uses password authenication.
  try {
    sftp.authenticatePw('myLogin', 'myPassword');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // After authenticating, the SFTP subsystem must be initialized:
  try {
    sftp.initializeSftp();
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // 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.
  final bFollowLinks = true;
  var bIsHandle = false;
  var fileSize = sftp.getFileSize32('someDir/someFile.dat', bFollowLinks, bIsHandle);
  if (fileSize < 0) {
    print(sftp.lastErrorText);
    return;
  }

  print('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.
  final String fileSizeStr;
  try {
    fileSizeStr = sftp.getFileSizeStr('someDir/someFile.dat', bFollowLinks, bIsHandle);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('file size = $fileSizeStr');

  // You can alternatively get the size with an open file handle.
  final String handle;
  try {
    handle = sftp.openFile('someDir/someFile.dat', 'readOnly', 'openExisting');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Get the size using the handle.
  bIsHandle = true;
  fileSize = sftp.getFileSize32('someDir/someFile.dat', bFollowLinks, bIsHandle);
  if (fileSize < 0) {
    print(sftp.lastErrorText);
    return;
  }

  print('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.
  try {
    sftp.closeHandle(handle);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }
}