IDebuggerVisualizerProvider.GetVisualizerAsync 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.
Requests the IDebuggerVisualizerProvider to initiate the visualization of a new target object.
public System.Threading.Tasks.Task<(Microsoft.VisualStudio.RpcContracts.RemoteUI.IRemoteUserControl RemoteUserControl, Microsoft.VisualStudio.RpcContracts.DebuggerVisualizers.IVisualizerTargetClient VisualizerTargetClient)> GetVisualizerAsync (Microsoft.VisualStudio.RpcContracts.DebuggerVisualizers.IVisualizerTarget visualizerTarget, Microsoft.VisualStudio.RpcContracts.DebuggerVisualizers.VisualizerTargetData visualizerTargetData, System.Threading.CancellationToken cancellationToken);abstract member GetVisualizerAsync : Microsoft.VisualStudio.RpcContracts.DebuggerVisualizers.IVisualizerTarget * Microsoft.VisualStudio.RpcContracts.DebuggerVisualizers.VisualizerTargetData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<ValueTuple<Microsoft.VisualStudio.RpcContracts.RemoteUI.IRemoteUserControl, Microsoft.VisualStudio.RpcContracts.DebuggerVisualizers.IVisualizerTargetClient>>Public Function GetVisualizerAsync (visualizerTarget As IVisualizerTarget, visualizerTargetData As VisualizerTargetData, cancellationToken As CancellationToken) As Task(Of ValueTuple(Of IRemoteUserControl, IVisualizerTargetClient))Parameters
- visualizerTarget
- IVisualizerTarget
The marshalable interface that can be used to request the data of the target object or replace it.
- visualizerTargetData
- VisualizerTargetData
Metadata about the target process and object.
- cancellationToken
- CancellationToken
Cancellation token for the async call.
Returns
An IRemoteUserControl marshalable interface that will show the representation of the object to be visualized and an IVisualizerTargetClient marshalable interface that can be used by Visual Studio to report changes about the state of the visualizer target.
Remarks
After this call is completed, the debugger should complete the following tasks in oder:
- Complete the initialization of the IRemoteUserControl,
- Call and await NotifyStateChangeAsync(VisualizerTargetStateNotification, CancellationToken) reporting the current availability state of the visualizer target to the debugger visualizer,
- Add the remote user control to the UI.
When the debugger visualizer is dismissed by the user, the debugger shoud complete the following tasks in oder:
- Dispose the visualizer target client,
- Dispose the remote user control.