IVsHierarchyDirectionalDropDataTarget.DropArea Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Informs the hierarchy that data has been dropped on an area.

public:
 int DropArea(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pDataObject, System::UInt32 grfKeyState, System::UInt32 itemid, System::UInt32 area, [Runtime::InteropServices::Out] System::UInt32 % pdwEffect);

int DropArea(Microsoft::VisualStudio::OLE::Interop::IDataObject const & pDataObject, unsigned int grfKeyState, unsigned int itemid, unsigned int area, [Runtime::InteropServices::Out] unsigned int & pdwEffect);

public int DropArea (Microsoft.VisualStudio.OLE.Interop.IDataObject pDataObject, uint grfKeyState, uint itemid, uint area, out uint pdwEffect);

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

Public Function DropArea (pDataObject As IDataObject, grfKeyState As UInteger, itemid As UInteger, area As UInteger, ByRef pdwEffect As UInteger) As Integer

Parameters

pDataObject

IDataObject

[in] 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.

grfKeyState

UInt32

[in] Current state of the keyboard and the mouse modifier keys.

itemid

UInt32

[in] Item identifier of the drop data target over which the item is being dragged. For a list of itemid values, see VSConstants.VSITEMID.

area

UInt32

[in] The area over which the item is to be dropped.

pdwEffect

UInt32

[in, out] Visual effects associated with the drag-and drop-operation, such as a cursor, bitmap, and so on. The value of dwEffects passed to the source object through the OnDropNotify(Int32, UInt32) method is the value of pdwEffects returned by this method.

Returns

Int32

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

Remarks

Valid values for grfKeyState are shown in the following table. These values can be combined using a bitwise OR operator.

Hex	Value	Description
0x0001	MK_LBUTTON	Left mouse button is clicked.
0x0002	MK_RBUTTON	Right mouse button is clicked.
0x0004	MK_SHIFT	SHIFT key is pressed.
0x0008	MK_CONTROL	CONTROL key is pressed.
0x0010	MK_MBUTTON	Middle mouse button is clicked.
0x0020	MK_ALT	ALT key is pressed.