DkmUserMessage.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, DkmUserMessageOutputKind, String, MessageBoxFlags, Int32)	Create a new DkmUserMessage object instance.
Create(DkmTransportConnection, DkmProcess, DkmUserMessageOutputKind, String, MessageBoxFlags, Int32, UInt64)	Create a new DkmUserMessage object instance. This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

Create(DkmTransportConnection, DkmProcess, DkmUserMessageOutputKind, String, MessageBoxFlags, Int32)

Create a new DkmUserMessage object instance.

public:
 static Microsoft::VisualStudio::Debugger::DkmUserMessage ^ Create(Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection ^ Connection, Microsoft::VisualStudio::Debugger::DkmProcess ^ Process, Microsoft::VisualStudio::Debugger::DkmUserMessageOutputKind OutputKind, System::String ^ MessageText, Microsoft::VisualStudio::Debugger::MessageBoxFlags MessageBoxFlags, int ErrorCode);

public static Microsoft.VisualStudio.Debugger.DkmUserMessage Create (Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection Connection, Microsoft.VisualStudio.Debugger.DkmProcess? Process, Microsoft.VisualStudio.Debugger.DkmUserMessageOutputKind OutputKind, string MessageText, Microsoft.VisualStudio.Debugger.MessageBoxFlags MessageBoxFlags, int ErrorCode);

static member Create : Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Microsoft.VisualStudio.Debugger.DkmProcess * Microsoft.VisualStudio.Debugger.DkmUserMessageOutputKind * string * Microsoft.VisualStudio.Debugger.MessageBoxFlags * int -> Microsoft.VisualStudio.Debugger.DkmUserMessage

Public Shared Function Create (Connection As DkmTransportConnection, Process As DkmProcess, OutputKind As DkmUserMessageOutputKind, MessageText As String, MessageBoxFlags As MessageBoxFlags, ErrorCode As Integer) As DkmUserMessage

Parameters

Connection

DkmTransportConnection

[In] Connection used to send the message to the debugger. This will value is usually obtained from DkmProcess.Connection unless the message needs to be sent before the DkmProcess is created.

Process

DkmProcess

[In,Optional] Process that this message is in reference to.

OutputKind

DkmUserMessageOutputKind

[In] Indicates where a DkmUserMessage should be output within the debugger IDE.

MessageText

String

[In] Text to display inside the message box or inside the output window. If an error code is provided, '%1' will be replaced with the text for the error message. For example: 'Unable to stand on my head. %1'.

MessageBoxFlags

MessageBoxFlags

[In] Win32 message box flags from winuser.h (ex: MB_OK). These flags are ignored if OutputKind is not set to 'MessageBox'.

ErrorCode

Int32

[In] Error code to display a message for. This value should be S_OK (0) if the message is not for an error.

Returns

DkmUserMessage

[Out] Result of this method call.

Create(DkmTransportConnection, DkmProcess, DkmUserMessageOutputKind, String, MessageBoxFlags, Int32, UInt64)

Create a new DkmUserMessage object instance.

This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

public:
 static Microsoft::VisualStudio::Debugger::DkmUserMessage ^ Create(Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection ^ Connection, Microsoft::VisualStudio::Debugger::DkmProcess ^ Process, Microsoft::VisualStudio::Debugger::DkmUserMessageOutputKind OutputKind, System::String ^ MessageText, Microsoft::VisualStudio::Debugger::MessageBoxFlags MessageBoxFlags, int ErrorCode, System::UInt64 TimeStamp);

public static Microsoft.VisualStudio.Debugger.DkmUserMessage Create (Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection Connection, Microsoft.VisualStudio.Debugger.DkmProcess? Process, Microsoft.VisualStudio.Debugger.DkmUserMessageOutputKind OutputKind, string MessageText, Microsoft.VisualStudio.Debugger.MessageBoxFlags MessageBoxFlags, int ErrorCode, ulong TimeStamp);

static member Create : Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Microsoft.VisualStudio.Debugger.DkmProcess * Microsoft.VisualStudio.Debugger.DkmUserMessageOutputKind * string * Microsoft.VisualStudio.Debugger.MessageBoxFlags * int * uint64 -> Microsoft.VisualStudio.Debugger.DkmUserMessage

Public Shared Function Create (Connection As DkmTransportConnection, Process As DkmProcess, OutputKind As DkmUserMessageOutputKind, MessageText As String, MessageBoxFlags As MessageBoxFlags, ErrorCode As Integer, TimeStamp As ULong) As DkmUserMessage

Parameters

Connection

DkmTransportConnection

[In] Connection used to send the message to the debugger. This will value is usually obtained from DkmProcess.Connection unless the message needs to be sent before the DkmProcess is created.

Process

DkmProcess

[In,Optional] Process that this message is in reference to.

OutputKind

DkmUserMessageOutputKind

[In] Indicates where a DkmUserMessage should be output within the debugger IDE.

MessageText

String

[In] Text to display inside the message box or inside the output window. If an error code is provided, '%1' will be replaced with the text for the error message. For example: 'Unable to stand on my head. %1'.

MessageBoxFlags

MessageBoxFlags

[In] Win32 message box flags from winuser.h (ex: MB_OK). These flags are ignored if OutputKind is not set to 'MessageBox'.

ErrorCode

Int32

[In] Error code to display a message for. This value should be S_OK (0) if the message is not for an error.

TimeStamp

UInt64

[In] An optional timestamp value. Typically, obtained via QueryPerformanceCounter when the object is created. Note that if the object is created on the local side of the remoting layer, no timestamp will be available.

Returns

DkmUserMessage

[Out] Result of this method call.