IVsHierarchyDropDataSource.GetDropInfo Method

Returns information about one or more of the items being dragged.

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

Syntax

'Declaration
Function GetDropInfo ( _
    <OutAttribute> ByRef pdwOKEffects As UInteger, _
    <OutAttribute> ByRef ppDataObject As IDataObject, _
    <OutAttribute> ByRef ppDropSource As IDropSource _
) As Integer
'Usage
Dim instance As IVsHierarchyDropDataSource
Dim pdwOKEffects As UInteger
Dim ppDataObject As IDataObject
Dim ppDropSource As IDropSource
Dim returnValue As Integer

returnValue = instance.GetDropInfo(pdwOKEffects, _
    ppDataObject, ppDropSource)

int GetDropInfo(
    out uint pdwOKEffects,
    out IDataObject ppDataObject,
    out IDropSource ppDropSource
)

int GetDropInfo(
    [OutAttribute] unsigned int% pdwOKEffects, 
    [OutAttribute] IDataObject^% ppDataObject, 
    [OutAttribute] IDropSource^% ppDropSource
)

abstract GetDropInfo : 
        pdwOKEffects:uint32 byref * 
        ppDataObject:IDataObject byref * 
        ppDropSource:IDropSource byref -> int

function GetDropInfo(
    pdwOKEffects : uint, 
    ppDataObject : IDataObject, 
    ppDropSource : IDropSource
) : int

Parameters

pdwOKEffects
Type: System.UInt32%
[out] Pointer to a DWORD value describing the effects displayed while the item is being dragged, such as cursor icons that change during the drag-and-drop operation. For example, if the item is dragged over an invalid target point (such as the item's original location), the cursor icon changes to a circle with a line through it. Similarly, if the item is dragged over a valid target point, the cursor icon changes to a file or folder.

ppDataObject
Type: Microsoft.VisualStudio.OLE.Interop.IDataObject%
[out] Pointer to the IDataObject interface on the item being dragged. This data object contains the data being transferred in the drag-and-drop operation. If the drop occurs, then this data object (item) is incorporated into the target hierarchy or hierarchy window.

ppDropSource
Type: Microsoft.VisualStudio.Shell.Interop.IDropSource%
[out] Pointer to the IDropSource interface of the item being dragged.

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 vsshell.idl:

HRESULT IVsHierarchyDropDataSource::GetDropInfo(
   [out]DWORD* pdwOKEffects,
   [out]IDataObject** ppDataObject,
   [out]IDropSource** ppDropSource
);

This method changes the cursor based on the item that the source data is dragged over. The cursor values are determined by OLE. For example, for an effect of DROP_NONE, a circle with a line through it is displayed; for a move, a box with an arrow is displayed; and for a copy, the move icon with a plus sign is displayed.

.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.