IDkmSymbolDocumentCollectionQuery.FindDocuments Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Debugger.ComponentInterfaces
Assembly:
Microsoft.VisualStudio.Debugger.Engine.dll
Package:
Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Returns document objects from search parameters contained in the document query. If the symbol file does not contain a reference to this document the returned document object will be NULL (S_FALSE return code in native). The returned document objects must be explicitly closed by the caller when the caller is done with the document.

public:
 cli::array <Microsoft::VisualStudio::Debugger::Symbols::DkmResolvedDocument ^> ^ FindDocuments(Microsoft::VisualStudio::Debugger::Symbols::DkmModule ^ module, Microsoft::VisualStudio::Debugger::Symbols::DkmSourceFileId ^ sourceFileId);
public Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocument[] FindDocuments (Microsoft.VisualStudio.Debugger.Symbols.DkmModule module, Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId sourceFileId);
public Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocument[]? FindDocuments (Microsoft.VisualStudio.Debugger.Symbols.DkmModule module, Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId sourceFileId);
abstract member FindDocuments : Microsoft.VisualStudio.Debugger.Symbols.DkmModule * Microsoft.VisualStudio.Debugger.Symbols.DkmSourceFileId -> Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocument[]
Public Function FindDocuments (module As DkmModule, sourceFileId As DkmSourceFileId) As DkmResolvedDocument()

Parameters

module
DkmModule

[In] The DkmModule class represents a code bundle (ex: dll or exe) which is or once was loaded into one or more processes. The DkmModule class is the central object to the symbol APIs, and is 1:1 with the symbol handler's notation of what is loaded. If a code bundle loads into three different processes (or the same process but with three different base addresses or three different app domains) but the symbol handler thinks of all of these as being identical, there will be only one module object.

sourceFileId
DkmSourceFileId

[In] Identifies a source file and provides the information which a symbol handler could use to search a symbol file (PDB) for information on this source file.

Returns

DkmResolvedDocument[]

[Out] A collection of the documents that matched the query.

Applies to