Xceed .NET Libraries Documentation
Xceed.SSH.Client Assembly / Xceed.SSH.Client Namespace / SSHClient Class / AllowTraceWriterClosure Property
Example


In This Topic
    AllowTraceWriterClosure Property
    In This Topic
    Get or sets a Boolean value that indicates whether SSHClient can close its assigned TraceWriter as part of its cleanup.
    null
    Syntax
    '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 null.

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

    Example
    null
    Example
    null
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also