Sample code for 30+ languages & platforms
Lianja

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 Lianja Downloads

Lianja
llSuccess = .F.

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

loSftp = createobject("CkSFtp")

//  Connect, authenticate, and initialize the SFTP subsystem.
lnPort = 22
llSuccess = loSftp.Connect("sftp.example.com",lnPort)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

//  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.
lcPassword = "mySshPassword"

llSuccess = loSftp.AuthenticatePw("mySshLogin",lcPassword)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

llSuccess = loSftp.InitializeSftp()
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

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

//  ... perform operations ...

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

loSftp.Disconnect()


release loSftp