ListView_SetCallbackMask macro (commctrl.h)

Article
04/02/2021

Changes the callback mask for a list-view control. You can use this macro or send the LVM_SETCALLBACKMASK message explicitly.

Syntax

void ListView_SetCallbackMask(
   hwnd,
   mask
);

Parameters

hwnd

Type: HWND

A handle to the list-view control.

mask

Type: UINT

The value of the callback mask. The bits of the mask indicate the item states or images for which the application stores the current state data. This value can be any combination of the following constants:

Value	Meaning
LVIS_CUT	The item is marked for a cut-and-paste operation.
LVIS_DROPHILITED	The item is highlighted as a drag-and-drop target.
LVIS_FOCUSED	The item has the focus.
LVIS_SELECTED	The item is selected.
LVIS_OVERLAYMASK	The application stores the image list index of the current overlay image for each item.
LVIS_STATEIMAGEMASK	The application stores the image list index of the current state image for each item.

Return value

None

Remarks

The callback mask of a list-view control is a set of bit flags that specify the item states for which the application, rather than the control, stores the current data. The callback mask applies to all of the control's items, unlike the callback item designation, which applies to a specific item. The callback mask is zero by default, meaning that the list-view control stores all item state information. After creating a list-view control and initializing its items, you can use the ListView_SetCallbackMask macro or LVM_SETCALLBACKMASK message to change the callback mask. To retrieve the current callback mask, send the LVM_GETCALLBACKMASK message.

For more information about overlay images and state images, see List-View Image Lists.

For more information on list-view callbacks, see Callback Items and the Callback Mask

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