Share via


OutputChannel Class

Definition

Provides functionality to manage an output window channel.

public sealed class OutputChannel : Microsoft.VisualStudio.Extensibility.Helpers.DisposableObject
type OutputChannel = class
    inherit DisposableObject
Public NotInheritable Class OutputChannel
Inherits DisposableObject
Inheritance
OutputChannel

Remarks

The OutputChannel offers three ways to write to output: (1) the write methods defined on the class, (2) the exposed TextWriter, and (3) the exposed PipeWriter. It is recommended that when writing to output, you choose only one method for writing and not alternate approaches, because mixing binary and text-based writing could lead to corruption, partially encoded characters, or thread-safety issues.

Properties

Identifier

Gets the identifier for the output window.

IsDisposed

Gets a value indicating whether the object has been disposed once, protects against double disposal.

(Inherited from DisposableObject)
PipeWriter

Gets the pipe writer instance to write to the output channel.

Writer

Gets the text writer instance to write to the output channel.

Methods

Dispose()

Disposes the current object then suppresses further finalization.

(Inherited from DisposableObject)
Dispose(Boolean)

Standard virtual overload for IDisposable pattern.

(Inherited from DisposableObject)
DisposeManagedResources()

Allows derived classes to provide custom dispose handling for managed resources.

(Inherited from DisposableObject)
DisposeNativeResources()

Allows derived classes to provide custom dispose handling for native resources.

(Inherited from DisposableObject)
WriteAsync(String)

Writes to the output channel asynchronously.

WriteLineAsync(String)

Writes a line to the output channel asynchronously.

Applies to