IVsToolboxActiveUserHook.InterceptDataObject Method

Article
03/06/2013

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function InterceptDataObject ( _
    pIn As IDataObject, _
    <OutAttribute> ByRef ppOut As IDataObject _
) As Integer

int InterceptDataObject(
    IDataObject pIn,
    out IDataObject ppOut
)

int InterceptDataObject(
    [InAttribute] IDataObject^ pIn, 
    [OutAttribute] IDataObject^% ppOut
)

abstract InterceptDataObject : 
        pIn:IDataObject * 
        ppOut:IDataObject byref -> int

function InterceptDataObject(
    pIn : IDataObject, 
    ppOut : IDataObject
) : int

Parameters

pIn
Type: Microsoft.VisualStudio.OLE.Interop.IDataObject
[in] An IDataObject containing the object being dropped on the Toolbox user.

ppOut
Type: Microsoft.VisualStudio.OLE.Interop.IDataObject%
[out] An IDataObject containing a modified object which will be handled by the Toolbox user.

Return Value

Type: System.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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.