DAD_SetDragImage function (shlobj_core.h)

Article
02/22/2024

[DAD_SetDragImage is available in Windows 2000 and Windows XP. It might be altered or unavailable in subsequent versions. Use ImageList_BeginDrag instead.]

Sets the drag image.

Syntax

BOOL DAD_SetDragImage(
  HIMAGELIST him,
  POINT      *pptOffset
);

Parameters

him

Type: HIMAGELIST

A handle to an image list. This parameter uses the zero index in the ImageList.

pptOffset

Type: POINT*

A pointer to the coordinates used as the hot spot for dragging the image. The coordinates are relative to upper-left corner of the image.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

Remarks

You can clear the drag image by setting the him parameter to -1 and the pptOffset parameter to NULL. The image must have been set within the same thread.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shlobj_core.h (include Shlobj.h)
Library	Shell32.lib
DLL	Shell32.dll (version 5.00 or later)
API set	ext-ms-win-shell-shell32-l1-2-1 (introduced in Windows 10, version 10.0.10240)

Share via