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

Download Chilkat for Unicode C

Unicode C

#include <C_CkSFtpW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSFtpW sftp;
    int port;
    const wchar_t *password;

    success = FALSE;

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

    sftp = CkSFtpW_Create();

    //  Connect, authenticate, and initialize the SFTP subsystem.
    port = 22;
    success = CkSFtpW_Connect(sftp,L"sftp.example.com",port);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp));
        CkSFtpW_Dispose(sftp);
        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.
    password = L"mySshPassword";

    success = CkSFtpW_AuthenticatePw(sftp,L"mySshLogin",password);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp));
        CkSFtpW_Dispose(sftp);
        return;
    }

    success = CkSFtpW_InitializeSftp(sftp);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp));
        CkSFtpW_Dispose(sftp);
        return;
    }

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

    //  ... perform operations ...

    //  Clear the accumulated log, for example before starting a new logical operation whose log you
    //  want to capture in isolation.
    CkSFtpW_ClearSessionLog(sftp);
    wprintf(L"Session log cleared.\n");

    CkSFtpW_Disconnect(sftp);


    CkSFtpW_Dispose(sftp);

    }