Edit

Share via

ImageList_SetDragCursorImage function (commctrl.h)

  • Article

Creates a new drag image by combining the specified image (typically a mouse cursor image) with the current drag image.

Syntax

BOOL ImageList_SetDragCursorImage(
  HIMAGELIST himlDrag,
  int        iDrag,
  int        dxHotspot,
  int        dyHotspot
);

Parameters

himlDrag

Type: HIMAGELIST

A handle to the image list that contains the new image to combine with the drag image.

iDrag

Type: int

The index of the new image to combine with the drag image.

dxHotspot

Type: int

The x-position of the hot spot within the new image.

dyHotspot

Type: int

The y-position of the hot spot within the new image.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header commctrl.h
Library Comctl32.lib
DLL Comctl32.dll