(Objective-C) SFTP Read Text File to String

Demonstrates how to download a text file from an SSH server directly into a string variable.

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

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

// 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;
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 file on the server:
NSString *handle = 0;
handle = [sftp OpenFile: @"hamlet.xml" access: @"readOnly" createDisp: @"openExisting"];
if (sftp.LastMethodSuccess != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

// Get the total size of this file (in bytes)
BOOL bFollowLinks = NO;
BOOL bIsHandle = YES;
int numBytes;

// bFollowLinks is ignored because we are passing a handle
// and not a remote filename.
// There are alternative methods for handling file sizes
// greater than 32-bit.  (See the reference documentation.)
numBytes = [[sftp GetFileSize64: handle bFollowLinks: bFollowLinks bIsHandle: bIsHandle] longLongValue];
if (numBytes < 0) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

// The charset indicates the character encoding of the text
// file on the SSH server.   Setting the charset correctly
// allows the Chilkat SFTP component to correctly interpret
// the bytes that represent the characters.
NSString *charset = 0;
charset = @"ansi";
NSString *fileContents = 0;
fileContents = [sftp ReadFileText: handle numBytes: [NSNumber numberWithInt: numBytes] charset: charset];
if (sftp.LastMethodSuccess != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}
else {
    NSLog(@"%@",@"Received file:");
    NSLog(@"%@",fileContents);
}

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

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