(Objective-C) SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

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

// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// Important: It is helpful to send the contents of the
// sftp.LastErrorText property when requesting support.

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

// Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = [NSNumber numberWithInt:5000];
sftp.IdleTimeoutMs = [NSNumber numberWithInt:10000];

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
NSString *hostname = @"www.my-sftp-server.com";
int port = 22;
BOOL success = [sftp Connect: hostname port: [NSNumber numberWithInt: port]];
if (success != YES) {
    NSLog(@"%@",sftp.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.
success = [sftp AuthenticatePw: @"myLogin" password: @"myPassword"];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

// After authenticating, the SFTP subsystem must be initialized:
success = [sftp InitializeSftp];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

// Open a directory on the server...
// Paths starting with a slash are "absolute", and are relative 
// to the root of the file system. Names starting with any other 
// character are relative to the user's default directory (home directory).
// A path component of ".." refers to the parent directory, 
// and "." refers to the current directory. 
NSString *handle = [sftp OpenDir: @"."];
if (sftp.LastMethodSuccess != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

// Download the directory listing:
CkoSFtpDir *dirListing = [sftp ReadDir: handle];
if (sftp.LastMethodSuccess != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

// Close the handle for the directory listing.
success = [sftp CloseHandle: handle];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

// Iterate over the files.
int i = 0;
int n = [dirListing.NumFilesAndDirs intValue];
while (i < n) {
    CkoSFtpFile *fileObj = [dirListing GetFileObject: [NSNumber numberWithInt: i]];

    NSLog(@"%@",fileObj.Filename);
    NSLog(@"%@",fileObj.FileType);
    NSLog(@"%@%d",@"Size in bytes: ",[fileObj.Size64 longLongValue]);
    NSLog(@"%@",@"----");

    i = i + 1;
}

NSLog(@"%@",@"Success.");