Objective-C

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

Download Chilkat for Objective-C

Objective-C

#import <CkoSFtp.h>
#import <NSString.h>

BOOL success = NO;

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

CkoSFtp *sftp = [[CkoSFtp alloc] init];

//  Connect, authenticate, and initialize the SFTP subsystem.
int port = 22;
success = [sftp Connect: @"sftp.example.com" port: [NSNumber numberWithInt: port]];
if (success == NO) {
    NSLog(@"%@",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.
NSString *password = @"mySshPassword";

success = [sftp AuthenticatePw: @"mySshLogin" password: password];
if (success == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

success = [sftp InitializeSftp];
if (success == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Open the remote directory.  OpenDir returns a handle string.
NSString *handle = [sftp OpenDir: @"subdir"];
if (sftp.LastMethodSuccess == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

NSLog(@"%@%@",@"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 == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

[sftp Disconnect];