Share via


OutputWindowExtensibility.GetChannelAsync Method

Definition

Creates a new output window channel. If a channel exists on the system with the identifier this call will fail.

public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Documents.OutputWindow> GetChannelAsync (string identifier, string displayNameResourceId, System.Threading.CancellationToken cancellationToken);
member this.GetChannelAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Documents.OutputWindow>
Public Function GetChannelAsync (identifier As String, displayNameResourceId As String, cancellationToken As CancellationToken) As Task(Of OutputWindow)

Parameters

identifier
String

Unique channel identifiers.

displayNameResourceId
String

Resource id to be used as display name for the output window channel. Consider using a pattern like nameof(Resources.MyChannelName).

cancellationToken
CancellationToken

Cancellation token to monitor.

Returns

an instance of Microsoft.VisualStudio.Extensibility.Documents.OutputWindowInternal.

Exceptions

Thrown when output channel is already created in the environment by another component.

Applies to