Share via

DkmCustomInstructionSymbol.Create Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Debugger.CustomRuntimes
Assembly:
Microsoft.VisualStudio.Debugger.Engine.dll
Package:
Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Create a new DkmCustomInstructionSymbol object instance.

public:
 static Microsoft::VisualStudio::Debugger::CustomRuntimes::DkmCustomInstructionSymbol ^ Create(Microsoft::VisualStudio::Debugger::Symbols::DkmModule ^ Module, Guid RuntimeType, System::Collections::ObjectModel::ReadOnlyCollection<System::Byte> ^ EntityId, System::UInt64 Offset, System::Collections::ObjectModel::ReadOnlyCollection<System::Byte> ^ AdditionalData);
public static Microsoft.VisualStudio.Debugger.CustomRuntimes.DkmCustomInstructionSymbol Create (Microsoft.VisualStudio.Debugger.Symbols.DkmModule Module, Guid RuntimeType, System.Collections.ObjectModel.ReadOnlyCollection<byte> EntityId, ulong Offset, System.Collections.ObjectModel.ReadOnlyCollection<byte> AdditionalData);
public static Microsoft.VisualStudio.Debugger.CustomRuntimes.DkmCustomInstructionSymbol Create (Microsoft.VisualStudio.Debugger.Symbols.DkmModule Module, Guid RuntimeType, System.Collections.ObjectModel.ReadOnlyCollection<byte>? EntityId, ulong Offset, System.Collections.ObjectModel.ReadOnlyCollection<byte>? AdditionalData);
static member Create : Microsoft.VisualStudio.Debugger.Symbols.DkmModule * Guid * System.Collections.ObjectModel.ReadOnlyCollection<byte> * uint64 * System.Collections.ObjectModel.ReadOnlyCollection<byte> -> Microsoft.VisualStudio.Debugger.CustomRuntimes.DkmCustomInstructionSymbol
Public Shared Function Create (Module As DkmModule, RuntimeType As Guid, EntityId As ReadOnlyCollection(Of Byte), Offset As ULong, AdditionalData As ReadOnlyCollection(Of Byte)) As DkmCustomInstructionSymbol

Parameters

Module
DkmModule

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

RuntimeType
Guid

[In] The Runtime Id identifies the execution environment for a particular piece of code. Runtime Ids are used by the dispatcher to decide which monitor to dispatch to. Note that the ordering of the runtime ID Guids is somewhat significant as this dictates which runtime gets the first shot during arbitration. Thus, if one wants to declare a new runtime instance which is built on the CLR, the runtime id should be less than DkmRuntimeId.Clr.

EntityId
ReadOnlyCollection<Byte>

[In,Optional] This is a runtime-specific data structure which custom runtimes may use to store the location of this instruction. Along with 'offset', this field will used to compare two instructions from the same module.

Offset
UInt64

[In] Along with 'EntityId' the 'Offset' field is used to uniquely identity an instruction. This could hold a pointer value (such as a pointer to the instruction) or an offset from the start of the function/module.

AdditionalData
ReadOnlyCollection<Byte>

[In,Optional] Additional runtime-specific data associated with an address. This data will not be used when comparing addresses.

Returns

DkmCustomInstructionSymbol

[Out] Result of this method call.

Applies to