ILanguageClient.ActivateAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.LanguageServer.Client

Assembly:: Microsoft.VisualStudio.LanguageServer.Client.dll

Package:: Microsoft.VisualStudio.LanguageServer.Client v17.11.32

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.

This method is called by Visual Studio to notify the extension that the LSP server should be started.

public:
 System::Threading::Tasks::Task<Microsoft::VisualStudio::LanguageServer::Client::Connection ^> ^ ActivateAsync(System::Threading::CancellationToken token);

public System.Threading.Tasks.Task<Microsoft.VisualStudio.LanguageServer.Client.Connection> ActivateAsync (System.Threading.CancellationToken token);

public System.Threading.Tasks.Task<Microsoft.VisualStudio.LanguageServer.Client.Connection?> ActivateAsync (System.Threading.CancellationToken token);

abstract member ActivateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.LanguageServer.Client.Connection>

Public Function ActivateAsync (token As CancellationToken) As Task(Of Connection)

Parameters

token: CancellationToken

Cancellation token.

Returns

Task<Connection>

A Connection object; or null if the language server cannot be started.

Remarks

Any exceptions thrown here will be caught and displayed to users.

This method is normally called by Visual Studio while handling the StartAsync event, before returning from such event. Visual Studio can call ActivateAsync(CancellationToken) again, in case the Connection with the server is closed, in order to activate the server again.

Applies to

Share via