DkmUserMessage Class

Definition

Namespace:

Microsoft.VisualStudio.Debugger

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Contains information about a message that is to be displayed to the user.

public ref class DkmUserMessage

[Windows::Foundation::Metadata::WebHostHidden]
public ref class DkmUserMessage

[Windows::Foundation::Metadata::WebHostHidden]
class DkmUserMessage

[System.Runtime.InteropServices.Guid("1a166c7c-4ae6-0992-82e2-c75555ed8055")]
public class DkmUserMessage

[<System.Runtime.InteropServices.Guid("1a166c7c-4ae6-0992-82e2-c75555ed8055")>]
type DkmUserMessage = class

Public Class DkmUserMessage

Inheritance

Object

DkmUserMessage

Attributes

GuidAttribute

Properties

Connection	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.
ErrorCode	Error code to display a message for. This value should be S_OK (0) if the message is not for an error.
MessageBoxFlags	Win32 message box flags from winuser.h (ex: MB_OK). These flags are ignored if OutputKind is not set to 'MessageBox'.
MessageText	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'.
OutputKind	Indicates where a DkmUserMessage should be output within the debugger IDE.
Process	[Optional] Process that this message is in reference to.
TimeStamp	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. This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

Methods

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.
DisplayPrompt()	Displays a message to the user inside the Visual Studio debugger IDE. This function waits for the Visual Studio IDE to complete processing this message. This method may not be called from code that runs as part of UI event processing. Doing so will cause a deadlock. This method requires DkmUserMessage.Process to be non-null.
DisplayPrompt(DkmWorkList, DkmCompletionRoutine<DkmDisplayUserMessagePromptAsyncResult>)	Displays a message to the user inside the Visual Studio debugger IDE. This method is the Async implementation. Once it is executed the completion routine will be called with the DkmProcess and the user response (Yes/No). This method requires DkmUserMessage.Process to be non-null. This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine. This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).
Post()	Displays a message to the user inside the Visual Studio debugger IDE. This function does not block waiting for the user to dismiss the error message.