DkmResolvedDocument.FindSymbols Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Symbols

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Overloads

FindSymbols(DkmTextSpan, String, DkmSourcePosition[])

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. Location constraint: API must be called from an IDE component (component level > 100,000).

FindSymbols(DkmWorkList, DkmTextSpan, String, DkmCompletionRoutine<DkmFindSymbolsAsyncResult>)

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. This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine. Location constraint: API must be called from an IDE component (component level > 100,000).

FindSymbols(DkmTextSpan, String, DkmSourcePosition[])

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.

Location constraint: API must be called from an IDE component (component level > 100,000).

public:
 cli::array <Microsoft::VisualStudio::Debugger::Symbols::DkmInstructionSymbol ^> ^ FindSymbols(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.DkmTextSpan TextSpan, string? Text, out Microsoft.VisualStudio.Debugger.Symbols.DkmSourcePosition[] SymbolLocation);

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

Public Function FindSymbols (TextSpan As DkmTextSpan, Text As String, ByRef SymbolLocation As DkmSourcePosition()) As DkmInstructionSymbol()

Parameters

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.

FindSymbols(DkmWorkList, DkmTextSpan, String, DkmCompletionRoutine<DkmFindSymbolsAsyncResult>)

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.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

Location constraint: API must be called from an IDE component (component level > 100,000).

public:
 void FindSymbols(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, Microsoft::VisualStudio::Debugger::Symbols::DkmTextSpan TextSpan, System::String ^ Text, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::Symbols::DkmFindSymbolsAsyncResult> ^ CompletionRoutine);

public void FindSymbols (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.Symbols.DkmTextSpan TextSpan, string? Text, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmFindSymbolsAsyncResult> CompletionRoutine);

member this.FindSymbols : Microsoft.VisualStudio.Debugger.DkmWorkList * Microsoft.VisualStudio.Debugger.Symbols.DkmTextSpan * string * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmFindSymbolsAsyncResult> -> unit

Public Sub FindSymbols (WorkList As DkmWorkList, TextSpan As DkmTextSpan, Text As String, CompletionRoutine As DkmCompletionRoutine(Of DkmFindSymbolsAsyncResult))

Parameters

WorkList

DkmWorkList

WorkList to append the new work item to.

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.

CompletionRoutine

DkmCompletionRoutine<DkmFindSymbolsAsyncResult>

Routine to fire when the request is complete. If the request is successfully appended to the work list, this will always fire (including when the operation is canceled). This will never fire if appending the work item fails.