HDM_SETHOTDIVIDER message

Changes the color of a divider between header items to indicate the destination of an external drag-and-drop operation. You can send this message explicitly or use the Header_SetHotDivider macro.

Parameters

wParam

The type of value represented by lParam. This value can be one of the following:

Value Meaning
TRUE
Indicates that lParam holds the client coordinates of the pointer.
FALSE
Indicates that lParam holds a divider index value.

lParam

A value held in lParam is interpreted depending on the value of wParam.

If wParam is TRUE, lParam represents the x- and y-coordinates of the pointer. The x-coordinate is in the low word, and the y-coordinate is in the high word. When the header control receives the message, it highlights the appropriate divider based on the lParam coordinates.

If wParam is FALSE, lParam represents the integer index of the divider to be highlighted.

Return value

Returns a value equal to the index of the divider that the control highlighted.

Remarks

This message creates an effect that a header control automatically produces when it has the HDS_DRAGDROP style. The HDM_SETHOTDIVIDER message is intended to be used when the owner of the control handles drag-and-drop operations manually.

Requirements

Requirement Value
Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
Header
Commctrl.h