Objective-C

SFTP Read Directory Listing

See more SFTP Examples

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

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

BOOL success = NO;

// 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;
success = [sftp Connect: hostname port: [NSNumber numberWithInt: port]];
if (success == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return true;
}

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

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

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

// Download the directory listing:

CkoSFtpDir *dirListing = [[CkoSFtpDir alloc] init];
success = [sftp ReadDirListing: handle dirObj: dirListing];
if (success == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return true;
}

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

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

    success = [dirListing FileAt: [NSNumber numberWithInt: i] fileObj: fileObj];
    if (success == NO) {
        NSLog(@"%@",dirListing.LastErrorText);
        return true;
    }

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

    i = i + 1;
}

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