Property Value

A System.Boolean value that is true if the object can close its assigned TraceWriter as part of its cleanup. false otherwise. The default value is false.

The TraceWriter property takes a System.IO.TextWriter object, which implements the IDisposable interface. Because SSHClient does not create this object, it is not responsible for it and therefore does not dispose of it when SSHClient itself is disposed. This task is left to the application.

As a convenience, you can set this property to true. The object will then call Dispose() on the TraceWriter's System.IO.TextWriter object, if it is not null.

This allows for a "fire and forget" effect on the TraceWriter.

When the property is set to true, it allows for cleanup of both the SSHClient's connection and the trace writer in one 'using' statement: BEGIN C# using( SSHClient ssh = new SSHClient() ) { ssh.TraceWriter = new StreamWriter( Application.StartupPath + "\\XceedSFtp.log", false ); ssh.AllowTraceWriterClosure = true; // Use the ssh client to connect, authenticate, start SFtp sessions, etc } END C# BEGIN VB.NET Using ssh As New SSHClient() ssh.TraceWriter = new StreamWriter( Application.StartupPath + "\XceedSFtp.log", false ) ssh.AllowTraceWriterClosure = true; ' Use the ssh client to connect, authenticate, start SFtp sessions, etc End Using END VB.NET When the property is set to false, it is your responsibility to close the trace writer once SSHClient is disposed or goes out of scope. Failure to do so might, for example, keep the file associated with the trace writer open and incomplete. You would then be unable to read it or use the file from another application.

Reference

SSHClient Class
SSHClient Members