IVsHierarchyDropDataSource.OnDropNotify(Int32, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Notifies clients that the dragged item was dropped.

public:
 int OnDropNotify(int fDropped, System::UInt32 dwEffects);

public:
 int OnDropNotify(int fDropped, unsigned int dwEffects);

int OnDropNotify(int fDropped, unsigned int dwEffects);

public int OnDropNotify (int fDropped, uint dwEffects);

abstract member OnDropNotify : int * uint32 -> int

Public Function OnDropNotify (fDropped As Integer, dwEffects As UInteger) As Integer

Parameters

fDropped: Int32

[in] If true, then the dragged item was dropped on the target. If false, then the drop did not occur.

dwEffects: UInt32

[in] Visual effects associated with the drag-and-drop operation, such as cursors, bitmaps, and so on. The value of dwEffects passed to the source object via OnDropNotify method is the value of pdwEffects returned by Drop(IDataObject, UInt32, UInt32, UInt32) method.

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::OnDropNotify(  
   [in]BOOL fDropped,  
   [in]DWORD dwEffects  
);

Use this method to determine whether the data from the source hierarchy was dropped onto the target. , Use the OnBeforeDropNotify method to let the source hierarchy allow or disallow the drop before it occurs.

The dwEffects parameter provides information that is returned by the Drop method, and which specifies the type of drop that occurred. This information is used by the source to determine whether an unanticipated effect occurred during the drop. For example, the user might have dragged an item from the source hierarchy to the target anticipating that the item would be moved to the target. However, if the target doesn't support a move, but does support a link, then the target notifies the source that a link occurred instead of a move. The source then uses this information to know that it should retain, rather than delete, its copy of the item.

Applies to