ProjectManager.DocumentSymbols(DocumentSymbolParams) 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 SymbolInformation for each namespace declaration, type declaration, and function or operation declaration within the specified file.

public Microsoft.VisualStudio.LanguageServer.Protocol.SymbolInformation[]? DocumentSymbols (Microsoft.VisualStudio.LanguageServer.Protocol.DocumentSymbolParams? param);

member this.DocumentSymbols : Microsoft.VisualStudio.LanguageServer.Protocol.DocumentSymbolParams -> Microsoft.VisualStudio.LanguageServer.Protocol.SymbolInformation[]

Public Function DocumentSymbols (param As DocumentSymbolParams) As SymbolInformation()

Parameters

param: DocumentSymbolParams

Returns

SymbolInformation[]

Remarks

Returns null if given uri is null or if the specified file is not listed as source file.

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