Open a Remote Directory on an SFTP Server

See more SFTP Examples

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 C# Downloads

Download Chilkat for C#

bool success = false;

//  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.

Chilkat.SFtp sftp = new Chilkat.SFtp();

//  Connect, authenticate, and initialize the SFTP subsystem.
int port = 22;
success = sftp.Connect("sftp.example.com",port);
if (success == false) {
    Debug.WriteLine(sftp.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.
string password = "mySshPassword";

success = sftp.AuthenticatePw("mySshLogin",password);
if (success == false) {
    Debug.WriteLine(sftp.LastErrorText);
    return;
}

success = sftp.InitializeSftp();
if (success == false) {
    Debug.WriteLine(sftp.LastErrorText);
    return;
}

//  Open the remote directory.  OpenDir returns a handle string.
string handle = sftp.OpenDir("subdir");
if (sftp.LastMethodSuccess == false) {
    Debug.WriteLine(sftp.LastErrorText);
    return;
}

Debug.WriteLine("Opened directory, handle = " + handle);

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

//  Close the handle when finished.
success = sftp.CloseHandle(handle);
if (success == false) {
    Debug.WriteLine(sftp.LastErrorText);
    return;
}

sftp.Disconnect();