DkmInspectionSession Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Debugger.Evaluation

Assembly:: Microsoft.VisualStudio.Debugger.Engine.dll

Package:: Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

DkmInspectionSession allows the various components which inspect data to store private data which is associated with a group of evaluations.

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

[System.Runtime.InteropServices.Guid("79035fe3-c25f-1535-6595-2b6b79621f50")]
public class DkmInspectionSession : Microsoft.VisualStudio.Debugger.DkmDataContainer, IDisposable

[<System.Runtime.InteropServices.Guid("79035fe3-c25f-1535-6595-2b6b79621f50")>]
type DkmInspectionSession = class
    inherit DkmDataContainer
    interface IDisposable

Public Class DkmInspectionSession
Inherits DkmDataContainer
Implements IDisposable

Inheritance: MarshalByRefObject

DkmDataContainer
DkmInspectionSession

Inheritance: Object

DkmDataContainer
DkmInspectionSession

Attributes: GuidAttribute

Implements: IDisposable

Properties

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)
Process	DkmProcess represents a target process which is being debugged. The debugger debugs processes, so this is the basic unit of debugging. A DkmProcess can represent a system process or a virtual process such as minidumps.
UniqueId	Guid which uniquely identifies this inspection session.

Methods

Close()	Closes a DkmInspectionSession object instance. This will release any resources associated with this object across all components. This includes resources across computer or managed/native marshalling boundaries. DkmInspectionSession objects are automatically closed when their associated DkmProcess object is closed. This method may only be called by the component which created the object.
Create(DkmProcess, DkmDataItem)	Create a new DkmInspectionSession object instance. The caller is responsible for closing the created object after they are done.
FindReturnValueContainer(Int32)	Find a DkmRawReturnValueContainer element within this DkmInspectionSession. If no element with the given input key is present, FindReturnValueContainer will fail. This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).
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)
GetReturnValueContainers()	GetReturnValueContainers enumerates the DkmRawReturnValueContainer elements of this DkmInspectionSession object. This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).
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.

Applies to

Share via