This macro retrieves the state of a list view item. You can use this macro or send the LVM_GETITEMSTATE message explicitly.
At a Glance
Header file: | Commctrl.h |
Windows CE versions: | 1.0 and later |
Related message: | LVM_GETITEMSTATE |
Syntax
UINT WINAPI ListView_GetItemState( HWND hwnd, int i, UINT mask );
Parameters
hwnd
Handle to the list view control.
i
Index of the list view item.
mask
State information to retrieve. It can be a combination of the following values:
Value | Description |
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, so it is surrounded by a standard focus rectangle. Although more than one item may be selected, only one item can have the focus. |
LVIS_SELECTED | The item is selected. The appearance of a selected item depends on whether it has the focus and also on the system colors used for selection. |
LVIS_OVERLAYMASK | Use this mask to retrieve the item’s overlay image index. |
LVIS_STATEIMAGEMASK | Use this mask to retrieve the item’s state image index. |
Return Values
Returns the current state for the specified item. The only valid bits in the return value are those that correspond to the bits set in the mask parameter.
Remarks
An item’s state information includes a set of bit flags as well as image list indexes that indicate the item’s state image and overlay image.
See Also