IDkmSymbolDocumentSpanQuery.FindSymbols Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Debugger.ComponentInterfaces

Assembly:: Microsoft.VisualStudio.Debugger.Engine.dll

Package:: Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

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.

Finds the symbols within the document which best match the input text span.

For IL-based languages, the symbol handler always return the DkmInstructionSymbol for sequence points. It will prefer sequence points which exactly match the text span followed by the sequence point or points which is left-most and which is inside the input span.

public:
 cli::array <Microsoft::VisualStudio::Debugger::Symbols::DkmInstructionSymbol ^> ^ FindSymbols(Microsoft::VisualStudio::Debugger::Symbols::DkmResolvedDocument ^ resolvedDocument, Microsoft::VisualStudio::Debugger::Symbols::DkmTextSpan textSpan, System::String ^ text, [Runtime::InteropServices::Out] cli::array <Microsoft::VisualStudio::Debugger::Symbols::DkmSourcePosition ^> ^ % symbolLocation);

public Microsoft.VisualStudio.Debugger.Symbols.DkmInstructionSymbol[] FindSymbols (Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocument resolvedDocument, Microsoft.VisualStudio.Debugger.Symbols.DkmTextSpan textSpan, string text, out Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePosition[] symbolLocation);

public Microsoft.VisualStudio.Debugger.Symbols.DkmInstructionSymbol[]? FindSymbols (Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocument resolvedDocument, Microsoft.VisualStudio.Debugger.Symbols.DkmTextSpan textSpan, string? text, out Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePosition[]? symbolLocation);

abstract member FindSymbols : Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocument * Microsoft.VisualStudio.Debugger.Symbols.DkmTextSpan * string * DkmSourcePosition[] -> Microsoft.VisualStudio.Debugger.Symbols.DkmInstructionSymbol[]

Public Function FindSymbols (resolvedDocument As DkmResolvedDocument, textSpan As DkmTextSpan, text As String, ByRef symbolLocation As DkmSourcePosition()) As DkmInstructionSymbol()

Parameters

resolvedDocument: DkmResolvedDocument

[In] Object which represents the result of a source file query against a symbol file (PDB). The resolved document object might encapsulate multiple document records with the symbol file. For example, in C++ compilation, each time that a header file is included there is another reference within the PDB. However, there is only one DkmResolvedDocument object for the header file.

textSpan: DkmTextSpan

[In] The text range (lines/column) to search for.

text: String

[In,Optional] The text to search for. When available, this will be provided if ResolvedDocument.TextRequested is set.

symbolLocation: DkmSourcePosition[]

[Out] The source location of each returned instruction symbol. The length of this array should be the same of the returned instruction symbol array.

Returns

DkmInstructionSymbol[]

[Out] The found instruction symbols which are within the specified text span.

Exceptions

DkmException

E_SCRIPT_FILE_DIFFERENT_CONTENT indicates that the content in the script file loaded by the target process doesn't match the provided Text.

Applies to

Share via