IVisualizerObjectProvider.TransferObject(Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.DebuggerVisualizers

Assembly:: Microsoft.VisualStudio.DebuggerVisualizers.dll

Package:: Microsoft.VisualStudio.DebuggerVisualizers v17.6.1032901

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.

Caution

This method uses binary serialization which is no longer supported, please use IVisualizerObjectProvider3.TransferObject instead.

Serializes the outgoing object using default serialization and then calls TransferData. Upon return deserializes the incoming data and returns the deserialized object

public:
 System::Object ^ TransferObject(System::Object ^ outgoingObject);

public:
 Platform::Object ^ TransferObject(Platform::Object ^ outgoingObject);

winrt::Windows::Foundation::IInspectable TransferObject(winrt::Windows::Foundation::IInspectable const & outgoingObject);

public object TransferObject (object outgoingObject);

[System.Obsolete("This method uses binary serialization which is no longer supported, please use IVisualizerObjectProvider3.TransferObject instead.")]
public object TransferObject (object outgoingObject);

abstract member TransferObject : obj -> obj

[<System.Obsolete("This method uses binary serialization which is no longer supported, please use IVisualizerObjectProvider3.TransferObject instead.")>]
abstract member TransferObject : obj -> obj

Public Function TransferObject (outgoingObject As Object) As Object

Parameters

outgoingObject: Object

An object that is to be transferred back to the debuggee side.

Returns

Object

The result of deserializing the return value of TransferData(Stream).

Attributes: ObsoleteAttribute

Examples

public class DebuggerSide : DialogDebuggerVisualizer
{
    override protected void Show(IDialogVisualizerService windowService, IVisualizerObjectProvider objectProvider)
    {
        // Get a string from the debuggee side and display it in a message box.  
        String myString = objectProvider.GetObject().ToString();
        MessageBox.Show(myString);

        // Modify the string and send it back to the debuggee side.  
        String myNewString = myString.ToUpper();
        // Make sure the object is replacable before you try to replace it.  
        // Otherwise, you will get an exception.  
        objectProvider.TransferObject(myNewString);
    }
    // Other DebuggerSide methods ommitted for clarity.  
}

Remarks

Transfers a data object back to the debuggee. Call this method after replacing the object that is being visualized. Call this method to transfer some information or call a command on the VisualizerObjectSource. This method just wraps TransferData(Stream) with calls to serialization and deserialization helper methods.

Applies to

Share via