IVsHierarchyDropDataSource2.GetDropInfo Method

Article
07/12/2014

Returns information about one or more of the dragged items.

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

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 indicating the effect of the drop: DROPEFFECT_COPY, DROPEFFECT_LINK, or DROPEFFECT_MOVE. The values are mutually exclusive and cannot be combined.

ppDataObject
Type: Microsoft.VisualStudio.OLE.Interop.IDataObject%

[out] Pointer to the IDataObject interface of the dragged item. This data object contains the data transferred in the drag-and-drop operation. If the drop occurs, then this data object (item) is incorporated in the target hierarchy or hierarchy window.

ppDropSource
Type: Microsoft.VisualStudio.Shell.Interop.IDropSource%

[out] Pointer to the IDropSource interface of the dragged item.

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 IVsHierarchyDropDataSource2::GetDropInfo(
   [out]DWORD* pdwOKEffects,
   [out]IDataObject** ppDataObject,
   [out]IDropSource** ppDropSource
);

Notes for Callers

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.

Share via