Clear the SFTP Session Log

See more SFTP Examples

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 C# Downloads

Download Chilkat for C#

bool success = false;

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

Chilkat.SFtp sftp = new Chilkat.SFtp();

//  Connect, authenticate, and initialize the SFTP subsystem.
int port = 22;
success = sftp.Connect("sftp.example.com",port);
if (success == false) {
    Debug.WriteLine(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.
string password = "mySshPassword";

success = sftp.AuthenticatePw("mySshLogin",password);
if (success == false) {
    Debug.WriteLine(sftp.LastErrorText);
    return;
}

success = sftp.InitializeSftp();
if (success == false) {
    Debug.WriteLine(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 = true;

//  ... perform operations ...

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

sftp.Disconnect();