DkmUserMessage.DisplayPrompt Method

  • Reference

Definition

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

Overloads

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).

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.

public:
 System::UInt32 DisplayPrompt();
public:
 unsigned int DisplayPrompt();
unsigned int DisplayPrompt();
public uint DisplayPrompt ();
member this.DisplayPrompt : unit -> uint32
Public Function DisplayPrompt () As UInteger

Returns

UInt32

[Out] Win32 'ID' code from displaying the message box (ex: IDYES). These codes are defined in winuser.h from the Windows SDK.

Applies to

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).

public:
 void DisplayPrompt(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::DkmDisplayUserMessagePromptAsyncResult> ^ CompletionRoutine);
public void DisplayPrompt (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.DkmDisplayUserMessagePromptAsyncResult> CompletionRoutine);
member this.DisplayPrompt : Microsoft.VisualStudio.Debugger.DkmWorkList * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.DkmDisplayUserMessagePromptAsyncResult> -> unit
Public Sub DisplayPrompt (WorkList As DkmWorkList, CompletionRoutine As DkmCompletionRoutine(Of DkmDisplayUserMessagePromptAsyncResult))

Parameters

WorkList
DkmWorkList

WorkList to append the new work item to.

CompletionRoutine
DkmCompletionRoutine<DkmDisplayUserMessagePromptAsyncResult>

Routine to fire when the request is complete. If the request is successfully appended to the work list, this will always fire (including when the operation is canceled). This will never fire if appending the work item fails.

Applies to