Udostępnij przez

DkmResolvedMappedDocument.Create Method

  • Reference

Definition

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

Creates a new resolved mapped document object. This API is typically called by the script local agent.

public:
 static Microsoft::VisualStudio::Debugger::Symbols::DkmResolvedMappedDocument ^ Create(Microsoft::VisualStudio::Debugger::Symbols::DkmModule ^ Module, System::String ^ DocumentName, Microsoft::VisualStudio::Debugger::Script::DkmScriptDocument ^ ScriptDocument, Microsoft::VisualStudio::Debugger::Symbols::DkmDocumentMatchStrength MatchStrength, Microsoft::VisualStudio::Debugger::Symbols::DkmResolvedDocumentWarning Warning, bool TextRequested, System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::VisualStudio::Debugger::Script::DkmScriptBlockMappingInfo ^> ^ ScriptBlocks, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);
public static Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedMappedDocument Create (Microsoft.VisualStudio.Debugger.Symbols.DkmModule Module, string DocumentName, Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument ScriptDocument, Microsoft.VisualStudio.Debugger.Symbols.DkmDocumentMatchStrength MatchStrength, Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocumentWarning Warning, bool TextRequested, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Script.DkmScriptBlockMappingInfo> ScriptBlocks, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);
public static Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedMappedDocument Create (Microsoft.VisualStudio.Debugger.Symbols.DkmModule Module, string DocumentName, Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument? ScriptDocument, Microsoft.VisualStudio.Debugger.Symbols.DkmDocumentMatchStrength MatchStrength, Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocumentWarning Warning, bool TextRequested, System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Script.DkmScriptBlockMappingInfo>? ScriptBlocks, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);
static member Create : Microsoft.VisualStudio.Debugger.Symbols.DkmModule * string * Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument * Microsoft.VisualStudio.Debugger.Symbols.DkmDocumentMatchStrength * Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocumentWarning * bool * System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.VisualStudio.Debugger.Script.DkmScriptBlockMappingInfo> * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedMappedDocument
Public Shared Function Create (Module As DkmModule, DocumentName As String, ScriptDocument As DkmScriptDocument, MatchStrength As DkmDocumentMatchStrength, Warning As DkmResolvedDocumentWarning, TextRequested As Boolean, ScriptBlocks As ReadOnlyCollection(Of DkmScriptBlockMappingInfo), DataItem As DkmDataItem) As DkmResolvedMappedDocument

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.

DocumentName
String

[In] Name of the source file. This is generally a full path, but in some scenarios it make be a partial path or just a name with extension (ex: example.cpp). In the case of a dynamic document (ex: running script from internet explorer) 'Path' could be a URL rather than a local file path.

ScriptDocument
DkmScriptDocument

[In,Optional] Script document which this resolved document represents. This should be null for non script-based symbol providers.

MatchStrength
DkmDocumentMatchStrength

[In] Indicates how strong of a match there was between the DkmDocumentQuery and the resulting DkmResolvedDocument.

Warning
DkmResolvedDocumentWarning

[In] Warning that occurred during the match. Depending on context, these may need to be surfaced to the user.

TextRequested
Boolean

[In] If true, return the source text.

ScriptBlocks
ReadOnlyCollection<DkmScriptBlockMappingInfo>

[In,Optional] Collection of script blocks in the project item document.

DataItem
DkmDataItem

[In,Optional] Data object to add to the new DkmResolvedMappedDocument instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmResolvedMappedDocument

[Out] Result of this method call.

Applies to