DkmResolvedMappedDocument Class

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Symbols

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Resolved document object which is created from a successful call to DkmModule.FindMappedDocuments or DkmScriptDocument.TryMappedResolve. This contains the information to map requests in server-side documents into requests on the client-side document.

public ref class DkmResolvedMappedDocument : Microsoft::VisualStudio::Debugger::Symbols::DkmResolvedDocument

[System.Runtime.InteropServices.Guid("a2390517-8273-fd47-12dc-fc0d945fa1a1")]
public class DkmResolvedMappedDocument : Microsoft.VisualStudio.Debugger.Symbols.DkmResolvedDocument

[<System.Runtime.InteropServices.Guid("a2390517-8273-fd47-12dc-fc0d945fa1a1")>]
type DkmResolvedMappedDocument = class
    inherit DkmResolvedDocument

Public Class DkmResolvedMappedDocument
Inherits DkmResolvedDocument

Inheritance

Object

DkmDataContainer

DkmResolvedDocument

DkmResolvedMappedDocument

Attributes

GuidAttribute

Properties

DocumentName	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. (Inherited from DkmResolvedDocument)
IsUnloaded	Returns true if a 'unloaded' event has been raised for this object (example: DkmThread::Unload is called) or if the object has been closed. Note that care must be used when checking this status as, without synchronization, the returned status may no longer be accurate the instruction after it is read. (Inherited from DkmDataContainer)
MatchStrength	Indicates how strong of a match there was between the DkmDocumentQuery and the resulting DkmResolvedDocument. (Inherited from DkmResolvedDocument)
Module	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. (Inherited from DkmResolvedDocument)
ScriptBlocks	[Optional] Collection of script blocks in the project item document.
ScriptDocument	[Optional] Script document which this resolved document represents. This should be null for non script-based symbol providers. (Inherited from DkmResolvedDocument)
TextRequested	If true, return the source text. (Inherited from DkmResolvedDocument)
UniqueId	Guid which uniquely identifies this object. (Inherited from DkmResolvedDocument)
Warning	Warning that occurred during the match. Depending on context, these may need to be surfaced to the user. (Inherited from DkmResolvedDocument)

Methods

Close()	Closes the resolved document object. This method must be invoked when the component which requested the resolved document is done with the object. DkmResolvedDocument objects are automatically closed when their associated DkmModule object is closed. (Inherited from DkmResolvedDocument)
Create(DkmModule, String, DkmScriptDocument, DkmDocumentMatchStrength, DkmResolvedDocumentWarning, Boolean, ReadOnlyCollection<DkmScriptBlockMappingInfo>, DkmDataItem)	Creates a new resolved mapped document object. This API is typically called by the script local agent.
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). (Inherited from DkmResolvedDocument)
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). (Inherited from DkmResolvedDocument)
GetDataItem<T>()	Gets the instance of 'T' which has been added to this container instance. If this container does not contain a 'T', this function will return null. (Inherited from DkmDataContainer)
RemoveDataItem<T>()	Remove the instance of 'T' from this container. It is usually unnecessary to call this method as a data container will automatically be emptied when the object is closed. (Inherited from DkmDataContainer)
SetDataItem<T>(DkmDataCreationDisposition, T)	Place a new item in the data container. (Inherited from DkmDataContainer)

Explicit Interface Implementations

IDisposable.Dispose()

(Inherited from DkmResolvedDocument)