DkmModule.Create Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Debugger.Symbols

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

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.

Overloads

Create(DkmModuleId, String, DkmCompilerId, DkmTransportConnection, DkmDataItem)

Creates a new DkmModule object, which represents the symbols for one or more loaded modules (module instances). These objects are created by symbol providers. After the DkmModule object is created, symbol providers should call DkmModuleInstance.SetModule to associate the DkmModuleInstance and DkmModule together.

This method will send a ModuleCreate event.

Create(DkmModuleId, String, DkmCompilerId, DkmTransportConnection, DkmWorkerProcessConnection, String, DkmDataItem)

This method will send a ModuleCreate event.

This API was introduced in Visual Studio 16 RTM (DkmApiVersion.VS16RTMPreview).

Create(DkmModuleId, String, DkmCompilerId, DkmTransportConnection, DkmWorkerProcessConnection, String, DkmModuleSymbolFlags, DkmDataItem)

Create(DkmModuleId, String, DkmCompilerId, DkmTransportConnection, DkmDataItem)

This method will send a ModuleCreate event.

public:
 static Microsoft::VisualStudio::Debugger::Symbols::DkmModule ^ Create(Microsoft::VisualStudio::Debugger::Symbols::DkmModuleId Id, System::String ^ Name, Microsoft::VisualStudio::Debugger::Evaluation::DkmCompilerId CompilerId, Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection ^ Connection, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Symbols.DkmModule Create (Microsoft.VisualStudio.Debugger.Symbols.DkmModuleId Id, string Name, Microsoft.VisualStudio.Debugger.Evaluation.DkmCompilerId CompilerId, Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection Connection, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);

static member Create : Microsoft.VisualStudio.Debugger.Symbols.DkmModuleId * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmCompilerId * Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Symbols.DkmModule

Public Shared Function Create (Id As DkmModuleId, Name As String, CompilerId As DkmCompilerId, Connection As DkmTransportConnection, DataItem As DkmDataItem) As DkmModule

Parameters

Id: DkmModuleId

[In] Guid pair used to uniquely identify a particular DkmModule instance.

Name: String

[In] Name of the module.

CompilerId: DkmCompilerId

[In] LanguageId/VendorId for the compiler which produced all of the code in this module. This is Guid.Empty/Guid.Empty if the module may contain a mixture of languages. This will almost always be Guid.Empty/Guid.Empty for PDB-based modules. It generally used by dynamic languages to avoid network round trips to discover the language of each symbol.

Connection: DkmTransportConnection

[In,Optional] For modules where symbols are loaded remotely, the connection property is used to determine where the Connection originated from. Otherwise this will be NULL.

DataItem: DkmDataItem

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

Returns

DkmModule

[Out] Result of this method call.

Applies to

Create(DkmModuleId, String, DkmCompilerId, DkmTransportConnection, DkmWorkerProcessConnection, String, DkmDataItem)

This method will send a ModuleCreate event.

This API was introduced in Visual Studio 16 RTM (DkmApiVersion.VS16RTMPreview).

public:
 static Microsoft::VisualStudio::Debugger::Symbols::DkmModule ^ Create(Microsoft::VisualStudio::Debugger::Symbols::DkmModuleId Id, System::String ^ Name, Microsoft::VisualStudio::Debugger::Evaluation::DkmCompilerId CompilerId, Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection ^ Connection, Microsoft::VisualStudio::Debugger::DefaultPort::DkmWorkerProcessConnection ^ SymbolsConnection, System::String ^ FilePath, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Symbols.DkmModule Create (Microsoft.VisualStudio.Debugger.Symbols.DkmModuleId Id, string Name, Microsoft.VisualStudio.Debugger.Evaluation.DkmCompilerId CompilerId, Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection Connection, Microsoft.VisualStudio.Debugger.DefaultPort.DkmWorkerProcessConnection SymbolsConnection, string FilePath, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);

static member Create : Microsoft.VisualStudio.Debugger.Symbols.DkmModuleId * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmCompilerId * Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Microsoft.VisualStudio.Debugger.DefaultPort.DkmWorkerProcessConnection * string * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Symbols.DkmModule

Public Shared Function Create (Id As DkmModuleId, Name As String, CompilerId As DkmCompilerId, Connection As DkmTransportConnection, SymbolsConnection As DkmWorkerProcessConnection, FilePath As String, DataItem As DkmDataItem) As DkmModule

Parameters

Id: DkmModuleId

[In] Guid pair used to uniquely identify a particular DkmModule instance.

Name: String

[In] Name of the module.

CompilerId: DkmCompilerId

Connection: DkmTransportConnection

[In,Optional] For modules where symbols are loaded remotely, the connection property is used to determine where the Connection originated from. Otherwise this will be NULL.

SymbolsConnection: DkmWorkerProcessConnection

[In,Optional] If non-null, this specifies a connection to a worker process where symbols for this DkmModule are processed. This will be null if symbols are loaded in the IDE process, or if they are loaded in the remote debugger (DkmModule.Connection is non-null).

FilePath: String

[In,Optional] If specified, this contains the full path to the symbol file which backs the DkmModule (ex: c:\myproj\bin\Debug\myproj.pdb).

DataItem: DkmDataItem

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

Returns

DkmModule

[Out] Result of this method call.

Applies to

Create(DkmModuleId, String, DkmCompilerId, DkmTransportConnection, DkmWorkerProcessConnection, String, DkmModuleSymbolFlags, DkmDataItem)

public static Microsoft.VisualStudio.Debugger.Symbols.DkmModule Create (Microsoft.VisualStudio.Debugger.Symbols.DkmModuleId Id, string Name, Microsoft.VisualStudio.Debugger.Evaluation.DkmCompilerId CompilerId, Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection Connection, Microsoft.VisualStudio.Debugger.DefaultPort.DkmWorkerProcessConnection SymbolsConnection, string FilePath, Microsoft.VisualStudio.Debugger.Symbols.DkmModuleSymbolFlags Flags, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);

static member Create : Microsoft.VisualStudio.Debugger.Symbols.DkmModuleId * string * Microsoft.VisualStudio.Debugger.Evaluation.DkmCompilerId * Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Microsoft.VisualStudio.Debugger.DefaultPort.DkmWorkerProcessConnection * string * Microsoft.VisualStudio.Debugger.Symbols.DkmModuleSymbolFlags * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Symbols.DkmModule

Public Shared Function Create (Id As DkmModuleId, Name As String, CompilerId As DkmCompilerId, Connection As DkmTransportConnection, SymbolsConnection As DkmWorkerProcessConnection, FilePath As String, Flags As DkmModuleSymbolFlags, DataItem As DkmDataItem) As DkmModule