AllowTraceWriterClosure Property

Get or sets a Boolean value that indicates whether SSHClient can close its assigned TraceWriter as part of its cleanup.

Syntax

Visual Basic
C#

'Declaration
 
Public Property AllowTraceWriterClosure As Boolean

'Usage
 
Dim instance As SSHClient
Dim value As Boolean
 
instance.AllowTraceWriterClosure = value
 
value = instance.AllowTraceWriterClosure

public bool AllowTraceWriterClosure {get; set;}

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.

Remarks

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 a null reference (Nothing in Visual Basic).

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

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SSHClient Class
SSHClient Members