INameSpaceTreeControlDropHandler::OnDrop method (shobjidl.h)

  • Article

Called on drop to set drop effect, as specified.

Syntax

HRESULT OnDrop(
  [in]      IShellItem      *psiOver,
  [in]      IShellItemArray *psiaData,
  [in]      int             iPosition,
  [in]      DWORD           grfKeyState,
  [in, out] DWORD           *pdwEffect
);

Parameters

[in] psiOver

Type: IShellItem*

A pointer to an IShellItem interface representing the item underneath the mouse cursor. Optional.

[in] psiaData

Type: IShellItemArray*

A pointer to an IShellItem array representing a data object.

[in] iPosition

Type: int

Specifies drop position.

[in] grfKeyState

Type: DWORD

The current state of keyboard modifier keys.

[in, out] pdwEffect

Type: DWORD*

A pointer to the drop effect value.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Note  To overwrite the default drop behavior, a client should fail this method; success proceeds with the default drop operation.
 

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header shobjidl.h

See also

IDropTarget::Drop

INameSpaceTreeControlDropHandler