Objective-C

SFTP Read Text File

See more SFTP Examples

Demonstrates how to open a text file on the SSH server and read text. Objective-C

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

BOOL success = NO;

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

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

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

//  Connect to the SSH server.  
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
NSString *hostname = @"sftp.example.com";
int port = 22;
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 file for reading.
NSString *handle = 0;
handle = [sftp OpenFile: @"myTest.txt" access: @"readOnly" createDisp: @"openExisting"];
if (sftp.LastMethodSuccess != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Assume the file we are reading contains the following text:
//  abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
//  (in ANSI format -- i.e. one byte per char).

//  Read 26 bytes:
NSString *sText = 0;
sText = [sftp ReadFileText: handle numBytes: [NSNumber numberWithInt: 26] charset: @"ansi"];
if (sftp.LastMethodSuccess != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Should print "abcdefghijklmnopqrstuvwxyz";
NSLog(@"%@",sText);

//  Read the next 10 bytes.
sText = [sftp ReadFileText: handle numBytes: [NSNumber numberWithInt: 10] charset: @"ansi"];
if (sftp.LastMethodSuccess != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Should print "1234567890";
NSLog(@"%@",sText);

//  Read the next 26 bytes.
sText = [sftp ReadFileText: handle numBytes: [NSNumber numberWithInt: 26] charset: @"ansi"];
if (sftp.LastMethodSuccess != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
NSLog(@"%@",sText);

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

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