IVsToolboxActiveUserHook.InterceptDataObject(IDataObject, IDataObject) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

This method is called by the Toolbox whenever one of its data objects participates in a drag-and-drop operation.

public:
 int InterceptDataObject(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pIn, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject ^ % ppOut);

public:
 int InterceptDataObject(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pIn, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject ^ &  ppOut);

int InterceptDataObject(Microsoft::VisualStudio::OLE::Interop::IDataObject const & pIn, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject const & & ppOut);

public int InterceptDataObject (Microsoft.VisualStudio.OLE.Interop.IDataObject pIn, out Microsoft.VisualStudio.OLE.Interop.IDataObject ppOut);

abstract member InterceptDataObject : Microsoft.VisualStudio.OLE.Interop.IDataObject * IDataObject -> int

Public Function InterceptDataObject (pIn As IDataObject, ByRef ppOut As IDataObject) As Integer

Parameters

pIn

IDataObject

[in] An IDataObject containing the object being dropped on the Toolbox user.

ppOut

IDataObject

[out] An IDataObject containing a modified object which will be handled by the Toolbox user.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsToolboxActiveUserHook::InterceptDataObject(  
   [in] IDataObject *pIn,  
   [out] IDataObject **ppOut  
);  

IVsToolboxActiveUserHook is used by an application that needs to intercept and modify certain Toolbox data objects when they are copied or dragged.

It should only be called by the Toolbox itself, as only the active Toolbox user can receive IVsToolboxActiveUserHook notifications.