Objective-C

Clear the SFTP Session Log

Demonstrates the Chilkat SFtp.ClearSessionLog method, which clears the in-memory text stored in the SessionLog property. It takes no arguments.

Background: With session logging enabled, the SessionLog accumulates a running record of the session's activity that is invaluable for diagnosing a failed transfer. Over a long-lived session that log grows unbounded, so clearing it frees memory — and, more usefully, lets you capture the log for one specific operation in isolation by clearing it just before and reading it just after.

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

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

BOOL success = NO;

//  Demonstrates the SFtp.ClearSessionLog method, which clears the in-memory text stored in the
//  SessionLog property.  It takes no arguments.

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;
}

//  When KeepSessionLog is enabled, the SessionLog property accumulates a record of the session's
//  activity, which is useful for debugging.
sftp.KeepSessionLog = YES;

//  ... perform operations ...

//  Clear the accumulated log, for example before starting a new logical operation whose log you
//  want to capture in isolation.
[sftp ClearSessionLog];
NSLog(@"%@",@"Session log cleared.");

[sftp Disconnect];