Share via


ImageList_BeginDrag (Compact 2013)

3/28/2014

This function begins dragging an image.

Syntax

BOOL WINAPI ImageList_BeginDrag(
  HIMAGELIST himlTrack, 
  int iTrack, 
  int dxHotspot, 
  int dyHotspot 
);

Parameters

  • himlTrack
    [in] Handle to the image list.
  • iTrack
    [in] Index of the image to drag.
  • dxHotspotand dyHotspot
    [in] Specifies the location of the drag position relative to the upper-left corner of the image.

Return Value

Nonzero indicates success. Zero indicates failure.

Remarks

This function creates a temporary image list that is used for dragging. In response to subsequent WM_MOUSEMOVE messages, you can move the drag image by using the ImageList_DragMove function. To end the drag operation, you can use the ImageList_EndDrag function.

Requirements

Header

commctrl.h

Library

commctrl.lib,
Imgctl.lib

See Also

Reference

Image List Functions
ImageList_DragMove
ImageList_EndDrag
ImageList_GetDragImage