DkmSuccessEvaluationResult.CreateDebuggeeSideVisualizerObject Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| CreateDebuggeeSideVisualizerObject(DkmWorkList, UInt32, DkmCompletionRoutine<DkmCreateDebuggeeSideVisualizerObjectAsyncResult>) |
Instantiates the debuggee-side Custom Visualizer type in the debuggee process. 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. Location constraint: API must be called from an IDE component (component level > 100,000). This API was introduced in Visual Studio 16 Update 10 (DkmApiVersion.VS16Update10). |
| CreateDebuggeeSideVisualizerObject(DkmWorkList, UInt32, Int32, DkmCompletionRoutine<DkmCreateDebuggeeSideVisualizerObject176AsyncResult>) |
Instantiates the debuggee-side Custom Visualizer type in the debuggee process and specifies the type of serialization that should be used when communicating with it. 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. Location constraint: API must be called from an IDE component (component level > 100,000). This API was introduced in Visual Studio 17 Update 6 (DkmApiVersion.VS17Update6). |
| CreateDebuggeeSideVisualizerObject(UInt32, String, String, String) |
Instantiates the debuggee-side Custom Visualizer type in the debuggee process. Note: this method got deprecated in favor of the one defined in IDkmClrCustomVisualizerObjectProvider1610 interface. Location constraint: API must be called from an IDE component (component level > 100,000). This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM). |
| CreateDebuggeeSideVisualizerObject(UInt32, String, String, String, Boolean) |
Instantiates the debuggee-side Custom Visualizer type in the debuggee process. Location constraint: API must be called from an IDE component (component level > 100,000). This API was introduced in Visual Studio 16 Update 10 (DkmApiVersion.VS16Update10). |
| CreateDebuggeeSideVisualizerObject(UInt32, Int32, Int32, String, String, String, Boolean) |
Instantiates the debuggee-side Custom Visualizer type in the debuggee process and specifies the type of serialization that should be used when communicating with it. Location constraint: API must be called from an IDE component (component level > 100,000). This API was introduced in Visual Studio 17 Update 6 (DkmApiVersion.VS17Update6). |
CreateDebuggeeSideVisualizerObject(DkmWorkList, UInt32, DkmCompletionRoutine<DkmCreateDebuggeeSideVisualizerObjectAsyncResult>)
Instantiates the debuggee-side Custom Visualizer type in the debuggee process.
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.
Location constraint: API must be called from an IDE component (component level > 100,000).
This API was introduced in Visual Studio 16 Update 10 (DkmApiVersion.VS16Update10).
public void CreateDebuggeeSideVisualizerObject (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, uint SelectedVisualizerIndex, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Evaluation.DkmCreateDebuggeeSideVisualizerObjectAsyncResult> CompletionRoutine);member this.CreateDebuggeeSideVisualizerObject : Microsoft.VisualStudio.Debugger.DkmWorkList * uint32 * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Evaluation.DkmCreateDebuggeeSideVisualizerObjectAsyncResult> -> unitPublic Sub CreateDebuggeeSideVisualizerObject (WorkList As DkmWorkList, SelectedVisualizerIndex As UInteger, CompletionRoutine As DkmCompletionRoutine(Of DkmCreateDebuggeeSideVisualizerObjectAsyncResult))Parameters
- WorkList
- DkmWorkList
WorkList to append the new work item to.
- SelectedVisualizerIndex
- UInt32
[In] The index of the selected visualizer.
- CompletionRoutine
- DkmCompletionRoutine<DkmCreateDebuggeeSideVisualizerObjectAsyncResult>
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
CreateDebuggeeSideVisualizerObject(DkmWorkList, UInt32, Int32, DkmCompletionRoutine<DkmCreateDebuggeeSideVisualizerObject176AsyncResult>)
Instantiates the debuggee-side Custom Visualizer type in the debuggee process and specifies the type of serialization that should be used when communicating with it.
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.
Location constraint: API must be called from an IDE component (component level > 100,000).
This API was introduced in Visual Studio 17 Update 6 (DkmApiVersion.VS17Update6).
public void CreateDebuggeeSideVisualizerObject (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, uint SelectedVisualizerIndex, int PreferredFormatterPolicy, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Evaluation.DkmCreateDebuggeeSideVisualizerObject176AsyncResult> CompletionRoutine);member this.CreateDebuggeeSideVisualizerObject : Microsoft.VisualStudio.Debugger.DkmWorkList * uint32 * int * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Evaluation.DkmCreateDebuggeeSideVisualizerObject176AsyncResult> -> unitPublic Sub CreateDebuggeeSideVisualizerObject (WorkList As DkmWorkList, SelectedVisualizerIndex As UInteger, PreferredFormatterPolicy As Integer, CompletionRoutine As DkmCompletionRoutine(Of DkmCreateDebuggeeSideVisualizerObject176AsyncResult))Parameters
- WorkList
- DkmWorkList
WorkList to append the new work item to.
- SelectedVisualizerIndex
- UInt32
[In] The index of the selected visualizer.
- PreferredFormatterPolicy
- Int32
[In] The value defined in Microsoft.VisualStudio.DebuggerVisualizers.FormatterPolicy that specifies which serialization mechanism the visualizer wants to use.
- CompletionRoutine
- DkmCompletionRoutine<DkmCreateDebuggeeSideVisualizerObject176AsyncResult>
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
CreateDebuggeeSideVisualizerObject(UInt32, String, String, String)
Instantiates the debuggee-side Custom Visualizer type in the debuggee process. Note: this method got deprecated in favor of the one defined in IDkmClrCustomVisualizerObjectProvider1610 interface.
Location constraint: API must be called from an IDE component (component level > 100,000).
This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).
public:
void CreateDebuggeeSideVisualizerObject(System::UInt32 SelectedVisualizerIndex, [Runtime::InteropServices::Out] System::String ^ % ExceptionType, [Runtime::InteropServices::Out] System::String ^ % ExceptionStackTrace, [Runtime::InteropServices::Out] System::String ^ % ExceptionMessage);public void CreateDebuggeeSideVisualizerObject (uint SelectedVisualizerIndex, out string ExceptionType, out string ExceptionStackTrace, out string ExceptionMessage);public void CreateDebuggeeSideVisualizerObject (uint SelectedVisualizerIndex, out string? ExceptionType, out string? ExceptionStackTrace, out string? ExceptionMessage);member this.CreateDebuggeeSideVisualizerObject : uint32 * string * string * string -> unitPublic Sub CreateDebuggeeSideVisualizerObject (SelectedVisualizerIndex As UInteger, ByRef ExceptionType As String, ByRef ExceptionStackTrace As String, ByRef ExceptionMessage As String)Parameters
- SelectedVisualizerIndex
- UInt32
[In] The index of the selected visualizer.
- ExceptionType
- String
[Out,Optional] The type of the exception thrown, if any.
- ExceptionStackTrace
- String
[Out,Optional] The stack trace of the exception thrown, if any.
- ExceptionMessage
- String
[Out,Optional] The exception message, if any.
Applies to
CreateDebuggeeSideVisualizerObject(UInt32, String, String, String, Boolean)
Instantiates the debuggee-side Custom Visualizer type in the debuggee process.
Location constraint: API must be called from an IDE component (component level > 100,000).
This API was introduced in Visual Studio 16 Update 10 (DkmApiVersion.VS16Update10).
public void CreateDebuggeeSideVisualizerObject (uint SelectedVisualizerIndex, out string? ExceptionType, out string? ExceptionStackTrace, out string? ExceptionMessage, out bool IsBinaryFormatterSupported);member this.CreateDebuggeeSideVisualizerObject : uint32 * string * string * string * bool -> unitPublic Sub CreateDebuggeeSideVisualizerObject (SelectedVisualizerIndex As UInteger, ByRef ExceptionType As String, ByRef ExceptionStackTrace As String, ByRef ExceptionMessage As String, ByRef IsBinaryFormatterSupported As Boolean)Parameters
- SelectedVisualizerIndex
- UInt32
[In] The index of the selected visualizer.
- ExceptionType
- String
[Out,Optional] The type of the exception thrown, if any.
- ExceptionStackTrace
- String
[Out,Optional] The stack trace of the exception thrown, if any.
- ExceptionMessage
- String
[Out,Optional] The exception message, if any.
- IsBinaryFormatterSupported
- Boolean
[Out,Optional] The debuggee will check if the process where it is hosted supports the Binary Formatter and return false if it doesn't so that the UI falls back to communicate via JSON.
Applies to
CreateDebuggeeSideVisualizerObject(UInt32, Int32, Int32, String, String, String, Boolean)
Instantiates the debuggee-side Custom Visualizer type in the debuggee process and specifies the type of serialization that should be used when communicating with it.
Location constraint: API must be called from an IDE component (component level > 100,000).
This API was introduced in Visual Studio 17 Update 6 (DkmApiVersion.VS17Update6).
public void CreateDebuggeeSideVisualizerObject (uint SelectedVisualizerIndex, int PreferredFormatterPolicy, out int ActualFormatterPolicy, out string? ExceptionType, out string? ExceptionStackTrace, out string? ExceptionMessage, out bool IsBinaryFormatterSupported);member this.CreateDebuggeeSideVisualizerObject : uint32 * int * int * string * string * string * bool -> unitPublic Sub CreateDebuggeeSideVisualizerObject (SelectedVisualizerIndex As UInteger, PreferredFormatterPolicy As Integer, ByRef ActualFormatterPolicy As Integer, ByRef ExceptionType As String, ByRef ExceptionStackTrace As String, ByRef ExceptionMessage As String, ByRef IsBinaryFormatterSupported As Boolean)Parameters
- SelectedVisualizerIndex
- UInt32
[In] The index of the selected visualizer.
- PreferredFormatterPolicy
- Int32
[In] The value defined in Microsoft.VisualStudio.DebuggerVisualizers.FormatterPolicy that specifies which serialization mechanism the visualizer wants to use.
- ActualFormatterPolicy
- Int32
[Out] The value defined in Microsoft.VisualStudio.DebuggerVisualizers.FormatterPolicy that specifies which serialization mechanism will be used.
- ExceptionType
- String
[Out,Optional] The type of the exception thrown, if any.
- ExceptionStackTrace
- String
[Out,Optional] The stack trace of the exception thrown, if any.
- ExceptionMessage
- String
[Out,Optional] The exception message, if any.
- IsBinaryFormatterSupported
- Boolean
[Out,Optional] The debuggee will check if the process where it is hosted supports the Binary Formatter and return false if it doesn't so that the UI falls back to communicate via JSON.