DkmClrRuntimeInstance.Create Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Clr

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Overloads

Create(DkmProcess, DkmRuntimeInstanceId, String, String, DkmDataItem)

Creates a new runtime instance object from a debug monitor. This method must be called from the event thread when a debug monitor detects that a new runtime instance has loaded (for example, when the corresponding runtime dll loads in the target process). This method will send a RuntimeInstanceLoad event. Location constraint: API must be called from a Monitor component (component level < 100,000).

Create(DkmProcess, DkmRuntimeInstanceId, DkmRuntimeCapabilities, DkmRuntimeInstance, String, String, DkmDataItem)

Creates a new runtime instance object from a debug monitor. This method must be called from the event thread when a debug monitor detects that a new runtime instance has loaded (for example, when the corresponding runtime dll loads in the target process). This method will send a RuntimeInstanceLoad event. Location constraint: API must be called from a Monitor component (component level < 100,000). This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).

Create(DkmProcess, DkmRuntimeInstanceId, String, String, DkmDataItem)

Creates a new runtime instance object from a debug monitor. This method must be called from the event thread when a debug monitor detects that a new runtime instance has loaded (for example, when the corresponding runtime dll loads in the target process).

This method will send a RuntimeInstanceLoad event.

Location constraint: API must be called from a Monitor component (component level < 100,000).

public:
 static Microsoft::VisualStudio::Debugger::Clr::DkmClrRuntimeInstance ^ Create(Microsoft::VisualStudio::Debugger::DkmProcess ^ Process, Microsoft::VisualStudio::Debugger::DkmRuntimeInstanceId Id, System::String ^ CORSystemDirectory, System::String ^ RuntimeVersion, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Clr.DkmClrRuntimeInstance Create (Microsoft.VisualStudio.Debugger.DkmProcess Process, Microsoft.VisualStudio.Debugger.DkmRuntimeInstanceId Id, string? CORSystemDirectory, string? RuntimeVersion, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.DkmProcess * Microsoft.VisualStudio.Debugger.DkmRuntimeInstanceId * string * string * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Clr.DkmClrRuntimeInstance

Public Shared Function Create (Process As DkmProcess, Id As DkmRuntimeInstanceId, CORSystemDirectory As String, RuntimeVersion As String, DataItem As DkmDataItem) As DkmClrRuntimeInstance

Parameters

Process

DkmProcess

[In] 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.

Id

DkmRuntimeInstanceId

[In] Identifies a DkmRuntimeInstance object within a process.

CORSystemDirectory

String

[In,Optional] The installation directory of the common language runtime (CLR) instance. For example 'c:\Windows\Microsoft.NET\Framework\v2.0.50727'. This is the same path returned from the GetCORSystemDirectory API, and it always includes the trailing slash.

RuntimeVersion

String

[In,Optional] The version string for the CLR instance (ex: 'v2.0.50727').

DataItem

DkmDataItem

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

Returns

DkmClrRuntimeInstance

[Out] Result of this method call.

Create(DkmProcess, DkmRuntimeInstanceId, DkmRuntimeCapabilities, DkmRuntimeInstance, String, String, DkmDataItem)

Creates a new runtime instance object from a debug monitor. This method must be called from the event thread when a debug monitor detects that a new runtime instance has loaded (for example, when the corresponding runtime dll loads in the target process).

This method will send a RuntimeInstanceLoad event.

Location constraint: API must be called from a Monitor component (component level < 100,000).

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

public:
 static Microsoft::VisualStudio::Debugger::Clr::DkmClrRuntimeInstance ^ Create(Microsoft::VisualStudio::Debugger::DkmProcess ^ Process, Microsoft::VisualStudio::Debugger::DkmRuntimeInstanceId Id, Microsoft::VisualStudio::Debugger::DkmRuntimeCapabilities Capabilities, Microsoft::VisualStudio::Debugger::DkmRuntimeInstance ^ ParentRuntime, System::String ^ CORSystemDirectory, System::String ^ RuntimeVersion, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Clr.DkmClrRuntimeInstance Create (Microsoft.VisualStudio.Debugger.DkmProcess Process, Microsoft.VisualStudio.Debugger.DkmRuntimeInstanceId Id, Microsoft.VisualStudio.Debugger.DkmRuntimeCapabilities Capabilities, Microsoft.VisualStudio.Debugger.DkmRuntimeInstance? ParentRuntime, string? CORSystemDirectory, string? RuntimeVersion, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.DkmProcess * Microsoft.VisualStudio.Debugger.DkmRuntimeInstanceId * Microsoft.VisualStudio.Debugger.DkmRuntimeCapabilities * Microsoft.VisualStudio.Debugger.DkmRuntimeInstance * string * string * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Clr.DkmClrRuntimeInstance

Public Shared Function Create (Process As DkmProcess, Id As DkmRuntimeInstanceId, Capabilities As DkmRuntimeCapabilities, ParentRuntime As DkmRuntimeInstance, CORSystemDirectory As String, RuntimeVersion As String, DataItem As DkmDataItem) As DkmClrRuntimeInstance

Parameters

Process

DkmProcess

[In] 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.

Id

DkmRuntimeInstanceId

[In] Identifies a DkmRuntimeInstance object within a process.

Capabilities

DkmRuntimeCapabilities

[In] Enumeration of runtime capabilities.

ParentRuntime

DkmRuntimeInstance

[In,Optional] For runtimes that are implemented on top of another runtime, this can optionally be used to indicant the logical parent. This can then be used to request services from the parent when the child runtime doesn't implement the service. This is currently used only for obtaining the top stack frame to evaluate a conditional breakpoint when the child runtime doesn't walk stacks itself.

CORSystemDirectory

String

[In,Optional] The installation directory of the common language runtime (CLR) instance. For example 'c:\Windows\Microsoft.NET\Framework\v2.0.50727'. This is the same path returned from the GetCORSystemDirectory API, and it always includes the trailing slash.

RuntimeVersion

String

[In,Optional] The version string for the CLR instance (ex: 'v2.0.50727').

DataItem

DkmDataItem

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

Returns

DkmClrRuntimeInstance

[Out] Result of this method call.