ProjectManager.HoverInformation Method

Reference

Definition

Namespace:: Microsoft.Quantum.QsCompiler.CompilationBuilder

Assembly:: Microsoft.Quantum.QsCompilationManager.dll

Package:: Microsoft.Quantum.Compiler v0.25.218240

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.

Returns information about the item at the specified position as Hover information.

public Microsoft.VisualStudio.LanguageServer.Protocol.Hover? HoverInformation (Microsoft.VisualStudio.LanguageServer.Protocol.TextDocumentPositionParams? param, Microsoft.VisualStudio.LanguageServer.Protocol.MarkupKind format = Microsoft.VisualStudio.LanguageServer.Protocol.MarkupKind.PlainText);

member this.HoverInformation : Microsoft.VisualStudio.LanguageServer.Protocol.TextDocumentPositionParams * Microsoft.VisualStudio.LanguageServer.Protocol.MarkupKind -> Microsoft.VisualStudio.LanguageServer.Protocol.Hover

Public Function HoverInformation (param As TextDocumentPositionParams, Optional format As MarkupKind = Microsoft.VisualStudio.LanguageServer.Protocol.MarkupKind.PlainText) As Hover

Parameters

param: TextDocumentPositionParams

format: MarkupKind

Returns

Hover

Remarks

Returns null if some parameters are unspecified (null), or if the specified file is not listed as source file, or if the specified position is not a valid position within the currently processed file content, or if no token exists at the specified position.

Fails silently without logging anything if an exception occurs upon evaluating the query (occasional failures are to be expected as the evaluation is a readonly query running in parallel to the ongoing processing).

Applies to