DkmCompiledVisualizationData Class

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Evaluation

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Represents the results of parsing one or more visualization files.

This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).

public ref class DkmCompiledVisualizationData : Microsoft::VisualStudio::Debugger::DkmDataContainer, IDisposable

[System.Runtime.InteropServices.Guid("3347c534-533c-275b-1828-d1dd73ba2fc0")]
public class DkmCompiledVisualizationData : Microsoft.VisualStudio.Debugger.DkmDataContainer, IDisposable

[<System.Runtime.InteropServices.Guid("3347c534-533c-275b-1828-d1dd73ba2fc0")>]
type DkmCompiledVisualizationData = class
    inherit DkmDataContainer
    interface IDisposable

Public Class DkmCompiledVisualizationData
Inherits DkmDataContainer
Implements IDisposable

Inheritance

Object

DkmDataContainer

DkmCompiledVisualizationData

Attributes

GuidAttribute

Implements

IDisposable

Properties

InspectionSession	The inspection session which owns the lifetime of this object. This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).
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)
Language	The language for which this visualization data applies to. This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).
UniqueId	Guid which uniquely identifies this inspection session. This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).
WorkerProcess	[Optional] This represents a transport connection used for symbol processing, or other memory intensive activities. This worker process may be remote or local. This API was introduced in Visual Studio 16 RTM (DkmApiVersion.VS16RTMPreview).

Methods

Close()	Closes a DkmCompiledVisualizationData object instance. This will release any resources associated with this object across all components. This includes resources across computer or managed/native marshalling boundaries. DkmCompiledVisualizationData objects are automatically closed when their associated DkmInspectionSession object is closed. This method may only be called by the component which created the object. This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).
Create(DkmLanguage, DkmInspectionSession, DkmDataItem)	Create a new DkmCompiledVisualizationData object instance. The caller is responsible for closing the created object after they are done. This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).
Create(DkmLanguage, DkmInspectionSession, DkmWorkerProcessConnection, DkmDataItem)	Create a new DkmCompiledVisualizationData object instance. The caller is responsible for closing the created object after they are done. This API was introduced in Visual Studio 16 RTM (DkmApiVersion.VS16RTMPreview).
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)
Initialize(String[])	Compiles object visualization data from a human-readable form into a DkmCompiledVisualizationData object. Location constraint: API must be called from an IDE component (component level > 100,000). This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).
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()

To be added.