Dart

Open a Remote Directory on an SFTP Server

Demonstrates the Chilkat SFtp.OpenDir method, which opens a remote directory and returns a handle for reading its entries. The only argument is the directory path. Close the handle with CloseHandle when finished.

Background: Listing a directory in SFTP is a handle-based operation, mirroring file access: open the directory to get a handle, read its entries, then close it. The handle is passed to ReadDirListing to retrieve the names and attributes. As with file handles, the directory handle is a server-side resource that should be closed to avoid exhausting the server's limits.

Chilkat Dart Downloads

Download Chilkat for Dart

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // Demonstrates the SFtp.OpenDir method, which opens a remote directory and returns a handle for
  // reading its entries.  The only argument is the directory path.

  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;
  }

  // Open the remote directory.  OpenDir returns a handle string.
  final String handle;
  try {
    handle = sftp.openDir('subdir');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('Opened directory, handle = $handle');

  // The directory entries are read with ReadDirListing using this handle.

  // Close the handle when finished.
  try {
    sftp.closeHandle(handle);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  sftp.disconnect();
}