ProjectManager.SignatureHelp(TextDocumentPositionParams, MarkupKind) 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 the signature help information for a call expression if there is such an expression at the specified position.

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

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

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

Parameters

param: TextDocumentPositionParams

format: MarkupKind

Returns

SignatureHelp

Remarks

Returns null if the given file is listed as to be ignored, or if some parameters are unspecified (null), or if the specified position is not a valid position within the currently processed file content, or if no call expression exists at the specified position at this time, or if no signature help information can be provided for the call expression 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