DkmCustomMessage.Create Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Overloads

Create(DkmTransportConnection, DkmProcess, Guid, Int32, Object, Object)	Create a new DkmCustomMessage object instance.
Create(DkmTransportConnection, DkmProcess, Guid, Int32, Object, Object, Object)	Create a new DkmCustomMessage object instance. This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).
Create(DkmTransportConnection, DkmProcess, Guid, Int32, Object, Object, Object, DkmWorkerProcessConnection)	Create a new DkmCustomMessage object instance. This API was introduced in Visual Studio 16 RTM (DkmApiVersion.VS16RTMPreview).

Create(DkmTransportConnection, DkmProcess, Guid, Int32, Object, Object)

Create a new DkmCustomMessage object instance.

public:
 static Microsoft::VisualStudio::Debugger::DkmCustomMessage ^ Create(Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection ^ Connection, Microsoft::VisualStudio::Debugger::DkmProcess ^ Process, Guid SourceId, int MessageCode, System::Object ^ Parameter1, System::Object ^ Parameter2);

public static Microsoft.VisualStudio.Debugger.DkmCustomMessage Create (Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection? Connection, Microsoft.VisualStudio.Debugger.DkmProcess? Process, Guid SourceId, int MessageCode, object? Parameter1, object? Parameter2);

static member Create : Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Microsoft.VisualStudio.Debugger.DkmProcess * Guid * int * obj * obj -> Microsoft.VisualStudio.Debugger.DkmCustomMessage

Public Shared Function Create (Connection As DkmTransportConnection, Process As DkmProcess, SourceId As Guid, MessageCode As Integer, Parameter1 As Object, Parameter2 As Object) As DkmCustomMessage

Parameters

Connection

DkmTransportConnection

[In,Optional] Transport connection used to send the message.

Process

DkmProcess

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

SourceId

Guid

[In] Identifies the source of an object. SourceIds are used to enable filtering in scenarios when multiple components may be creating instances of a class. For example, source ids can be used to determine if a breakpoint comes from the AD7 AL (ex: user breakpoint, or other breakpoint visible at the SDM level) instead of a breakpoint which may be created by another component (for example an internal breakpoint used for stepping).

MessageCode

Int32

[In] Identifies the type of custom event being sent. Partners are free to define any set of values.

Parameter1

Object

[In,Optional] Specifies additional message-specific information. Note that if this message may need to travel over remoting boundaries, it is important to restrict the type of this parameter to something which can be marshalled: strings, primitives (ex: int), and arrays of primitives (ex: byte array).

Parameter2

Object

[In,Optional] Specifies additional message-specific information. Note that if this message may need to travel over remoting boundaries, it is important to restrict the type of this parameter to something which can be marshalled: strings, primitives (ex: int), and arrays of primitives (ex: byte array).

Returns

DkmCustomMessage

[Out] Result of this method call.

Create(DkmTransportConnection, DkmProcess, Guid, Int32, Object, Object, Object)

Create a new DkmCustomMessage object instance.

This API was introduced in Visual Studio 15 RTM (DkmApiVersion.VS15RTM).

public:
 static Microsoft::VisualStudio::Debugger::DkmCustomMessage ^ Create(Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection ^ Connection, Microsoft::VisualStudio::Debugger::DkmProcess ^ Process, Guid SourceId, int MessageCode, System::Object ^ Parameter1, System::Object ^ Parameter2, System::Object ^ Parameter3);

public static Microsoft.VisualStudio.Debugger.DkmCustomMessage Create (Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection? Connection, Microsoft.VisualStudio.Debugger.DkmProcess? Process, Guid SourceId, int MessageCode, object? Parameter1, object? Parameter2, object? Parameter3);

static member Create : Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Microsoft.VisualStudio.Debugger.DkmProcess * Guid * int * obj * obj * obj -> Microsoft.VisualStudio.Debugger.DkmCustomMessage

Public Shared Function Create (Connection As DkmTransportConnection, Process As DkmProcess, SourceId As Guid, MessageCode As Integer, Parameter1 As Object, Parameter2 As Object, Parameter3 As Object) As DkmCustomMessage

Parameters

Connection

DkmTransportConnection

[In,Optional] Transport connection used to send the message.

Process

DkmProcess

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

SourceId

Guid

[In] Identifies the source of an object. SourceIds are used to enable filtering in scenarios when multiple components may be creating instances of a class. For example, source ids can be used to determine if a breakpoint comes from the AD7 AL (ex: user breakpoint, or other breakpoint visible at the SDM level) instead of a breakpoint which may be created by another component (for example an internal breakpoint used for stepping).

MessageCode

Int32

[In] Identifies the type of custom event being sent. Partners are free to define any set of values.

Parameter1

Object

[In,Optional] Specifies additional message-specific information. Note that if this message may need to travel over remoting boundaries, it is important to restrict the type of this parameter to something which can be marshalled: strings, primitives (ex: int), and arrays of primitives (ex: byte array).

Parameter2

Object

[In,Optional] Specifies additional message-specific information. Note that if this message may need to travel over remoting boundaries, it is important to restrict the type of this parameter to something which can be marshalled: strings, primitives (ex: int), and arrays of primitives (ex: byte array).

Parameter3

Object

[In,Optional] Specifies additional message-specific information. Note that if this message may need to travel over remoting boundaries, it is important to restrict the type of this parameter to something which can be marshalled: strings, primitives (ex: int), and arrays of primitives (ex: byte array).

Returns

DkmCustomMessage

[Out] Result of this method call.

Create(DkmTransportConnection, DkmProcess, Guid, Int32, Object, Object, Object, DkmWorkerProcessConnection)

Create a new DkmCustomMessage object instance.

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

public:
 static Microsoft::VisualStudio::Debugger::DkmCustomMessage ^ Create(Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection ^ Connection, Microsoft::VisualStudio::Debugger::DkmProcess ^ Process, Guid SourceId, int MessageCode, System::Object ^ Parameter1, System::Object ^ Parameter2, System::Object ^ Parameter3, Microsoft::VisualStudio::Debugger::DefaultPort::DkmWorkerProcessConnection ^ WorkerProcess);

public static Microsoft.VisualStudio.Debugger.DkmCustomMessage Create (Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection? Connection, Microsoft.VisualStudio.Debugger.DkmProcess? Process, Guid SourceId, int MessageCode, object? Parameter1, object? Parameter2, object? Parameter3, Microsoft.VisualStudio.Debugger.DefaultPort.DkmWorkerProcessConnection? WorkerProcess);

static member Create : Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Microsoft.VisualStudio.Debugger.DkmProcess * Guid * int * obj * obj * obj * Microsoft.VisualStudio.Debugger.DefaultPort.DkmWorkerProcessConnection -> Microsoft.VisualStudio.Debugger.DkmCustomMessage

Public Shared Function Create (Connection As DkmTransportConnection, Process As DkmProcess, SourceId As Guid, MessageCode As Integer, Parameter1 As Object, Parameter2 As Object, Parameter3 As Object, WorkerProcess As DkmWorkerProcessConnection) As DkmCustomMessage

Parameters

Connection

DkmTransportConnection

[In,Optional] Transport connection used to send the message.

Process

DkmProcess

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

SourceId

Guid

[In] Identifies the source of an object. SourceIds are used to enable filtering in scenarios when multiple components may be creating instances of a class. For example, source ids can be used to determine if a breakpoint comes from the AD7 AL (ex: user breakpoint, or other breakpoint visible at the SDM level) instead of a breakpoint which may be created by another component (for example an internal breakpoint used for stepping).

MessageCode

Int32

[In] Identifies the type of custom event being sent. Partners are free to define any set of values.

Parameter1

Object

[In,Optional] Specifies additional message-specific information. Note that if this message may need to travel over remoting boundaries, it is important to restrict the type of this parameter to something which can be marshalled: strings, primitives (ex: int), and arrays of primitives (ex: byte array).

Parameter2

Object

[In,Optional] Specifies additional message-specific information. Note that if this message may need to travel over remoting boundaries, it is important to restrict the type of this parameter to something which can be marshalled: strings, primitives (ex: int), and arrays of primitives (ex: byte array).

Parameter3

Object

[In,Optional] Specifies additional message-specific information. Note that if this message may need to travel over remoting boundaries, it is important to restrict the type of this parameter to something which can be marshalled: strings, primitives (ex: int), and arrays of primitives (ex: byte array).

WorkerProcess

DkmWorkerProcessConnection

[In,Optional] If non-null, this specifies the worker process connection that the message should be sent through.

Returns

DkmCustomMessage

[Out] Result of this method call.