IVsHierarchyDropDataSource.GetDropInfo Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

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

public:
 int GetDropInfo([Runtime::InteropServices::Out] System::UInt32 % pdwOKEffects, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject ^ % ppDataObject, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IDropSource ^ % ppDropSource);

int GetDropInfo([Runtime::InteropServices::Out] unsigned int & pdwOKEffects, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject const & & ppDataObject, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IDropSource const & & ppDropSource);

public int GetDropInfo (out uint pdwOKEffects, out Microsoft.VisualStudio.OLE.Interop.IDataObject ppDataObject, out Microsoft.VisualStudio.Shell.Interop.IDropSource ppDropSource);

abstract member GetDropInfo : uint32 * IDataObject * IDropSource -> int

Public Function GetDropInfo (ByRef pdwOKEffects As UInteger, ByRef ppDataObject As IDataObject, ByRef ppDropSource As IDropSource) As Integer

Parameters

pdwOKEffects: 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: 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: IDropSource

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

Returns

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.

Applies to

Share via