Edit

Share via

ImageList_GetDragImage function (commctrl.h)

  • Article

Retrieves the temporary image list that is used for the drag image. The function also retrieves the current drag position and the offset of the drag image relative to the drag position.

Syntax

HIMAGELIST ImageList_GetDragImage(
  POINT *ppt,
  POINT *pptHotspot
);

Parameters

ppt

Type: POINT*

A pointer to a POINT structure that receives the current drag position. Can be NULL.

pptHotspot

Type: POINT*

A pointer to a POINT structure that receives the offset of the drag image relative to the drag position. Can be NULL.

Return value

Type: HIMAGELIST

Returns the handle to the image list if successful, or NULL otherwise.

Remarks

The temporary image list is destroyed when the ImageList_EndDrag function is called. To begin a drag operation, use the ImageList_BeginDrag function.

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