OutputWindowExtensibility.GetChannelAsync Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.Documents

Assembly:: Microsoft.VisualStudio.Extensibility.dll

Package:: Microsoft.VisualStudio.Extensibility v17.11.350

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Task<OutputWindow>

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

Exceptions

InvalidOperationException

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

Applies to

Share via