IVsHierarchyDropDataTarget.DragOver(UInt32, UInt32, UInt32) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Called when one or more items are dragged over the target hierarchy or hierarchy window.

public:
 int DragOver(System::UInt32 grfKeyState, System::UInt32 itemid, [Runtime::InteropServices::Out] System::UInt32 % pdwEffect);

int DragOver(unsigned int grfKeyState, unsigned int itemid, [Runtime::InteropServices::Out] unsigned int & pdwEffect);

public int DragOver (uint grfKeyState, uint itemid, out uint pdwEffect);

abstract member DragOver : uint32 * uint32 * uint32 -> int

Public Function DragOver (grfKeyState As UInteger, itemid As UInteger, ByRef pdwEffect As UInteger) As Integer

Parameters

grfKeyState

UInt32

[in] Current state of the keyboard keys and the mouse modifier buttons. Valid values are shown in the following table. These values can be combined using a bitwise OR operator.[1|1] Hex[1|2] Value[1|3] Description[2|1] 0x0001[2|2] MK_LBUTTON[2|3] Left mouse button is clicked.[3|1] 0x0002[3|2] MK_RBUTTON[3|3] Right mouse button is clicked.[4|1] 0x0004[4|2] MK_SHIFT[4|3] SHIFT key is pressed.[5|1] 0x0008[5|2] MK_CONTROL[5|3] CONTROL key is pressed.[6|1] 0x0010[6|2] MK_MBUTTON[6|3] Middle mouse button is clicked.[7|1] 0x0020[7|2] MK_ALT[7|3] ALT key is pressed.

itemid

UInt32

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

pdwEffect

UInt32

[in, out] On entry, pointer to the value of the pdwEffect parameter of the IVsHierarchy object, identifying all effects that the hierarchy supports. On return, the pdwEffect parameter must contain one of the effect flags that indicate the result of the drop operation. For a list of pwdEffects values, see DragEnter(IDataObject, UInt32, UInt32, UInt32).

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 IVsHierarchyDropDataTarget::DragOver(  
   [in]DWORD grfKeyState,  
   [in]VSITEMID itemid,  
   [in, out]DWORD * pdwEffect  
);  

The function passes the state of the keyboard keys and mouse modifier buttons (whether one or more is being pressed).