INameSpaceTreeControlDropHandler::OnDragEnter method (shobjidl.h)

Article
02/22/2024

Called on drag enter to set drag effect, as specified.

Syntax

HRESULT OnDragEnter(
  [in]      IShellItem      *psiOver,
  [in]      IShellItemArray *psiaData,
  [in]      BOOL            fOutsideSource,
  [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 containing the items being dragged.

[in] fOutsideSource

Type: BOOL

Specifies whether drag started outside target area.

[in] grfKeyState

Type: DWORD

The current state of keyboard modifier keys.

[in, out] pdwEffect

Type: DWORD*

On success, contains a pointer to the drag effect value.

Return value

Type: HRESULT

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

Remarks

Failing this method blocks the drag operation in the namespace tree control (NSTC).

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