LV_ITEM info  Overview  Group

The LV_ITEM structure specifies or receives the attributes of a list view item.

typedef struct _LV_ITEM { 

    UINT   mask; 

    int    iItem; 

    int    iSubItem; 

    UINT   state; 

    UINT   stateMask; 

    LPTSTR  pszText; 

    int    cchTextMax; 

    int    iImage;       // index of the list view item’s icon 

    LPARAM lParam;       // 32-bit value to associate with item 

} LV_ITEM; 

 

Members

mask

A set of bit flags that specify attributes of this data structure or of an operation that is using this structure.

The following bit flags specify the members of the LV_ITEM structure that contain valid data or need to be filled in. One or more of these bit flags may be set:

Value	Meaning
LVIF_TEXT	The pszText member is valid or needs to be filled in.
LVIF_IMAGE	The iImage member is valid or needs to be filled in.
LVIF_PARAM	The lParam member is valid or needs to be filled in.
LVIF_STATE	The state member is valid or needs to be filled in..

The following bit flag is used with the LVN_GETDISPINFO notification message:

Value	Meaning
LVIF_DI_SETITEM	The operating system should store the requested list item information, and not ask for it again.

iItem

Specifies the zero-based index of the item to which this structure refers.

iSubItem

Specifies the one-based index of the subitem to which this structure refers, or zero if this structure refers to an item rather than a subitem.

state

Indicates the item’s state, state image, and overlay image. The stateMask member indicates the valid bits of the state member.

The low-order byte contains a set of bit flags that indicate the item’s state. This byte can be a combination of the following values.

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, 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 on the system colors used for selection.

Bits 8 through 11 of the state member specify the one-based index of an overlay image in the control’s image lists. Both the full-sized icon image list and the small icon image list can have overlay images. The overlay image is superimposed over the item’s icon image. If these bits are zero, the item has no overlay image. To isolate these bits, use the LVIS_OVERLAYMASK mask.

Bits 12 through 15 of the state member specify the one-based index of an image in the control’s state image list. The state image is displayed next to an item’s icon to indicate an application-defined state. If these bits are zero, the item has no state image. To isolate these bits, use the LVIS_STATEIMAGEMASK mask.

If you are retrieving an item’s state, the state member receives the state of the bits indicated by the stateMask member.

If you are setting an item’s state, the stateMask member indicates the bits of the state member to set.

stateMask

Specifies the bits of the state member that are valid. If you are retrieving an item’s state, set the bits of the stateMask member to indicate the bits to be returned in the state member. If you are setting an item’s state, set the bits of the stateMask member to indicate the bits of the state member that you want to set. To set or retrieve an item’s overlay image index, set the LVIS_OVERLAYMASK bits. To set or retrieve an item’s state image index, set the LVIS_STATEIMAGEMASK bits.

pszText

Pointer to a null-terminated string that contains the item text if the structure specifies item attributes. If this member is the LPSTR_TEXTCALLBACK value, the item is a callback item. Do not set the pszText member to LPSTR_TEXTCALLBACK if the list view control has LVS_SORTASCENDING or LVS_SORTDESCENDING style.

If the structure is receiving item attributes, this member is the pointer to the buffer that receives the item text.

cchTextMax

Size of the buffer pointed to by the pszText member if the structure is receiving item attributes. If the structure specifies item attributes, this member is ignored.

iImage

Index of the list view item’s icon in the icon and small icon image lists.

If this member is the I_IMAGECALLBACK value, the parent window is responsible for storing the index. In this case, the list view control sends the parent an LVN_GETDISPINFO notification message to get the index when it needs to display the image.

lParam

A 32-bit value to associate with the item. If you use the LVM_SORTITEMS message, the list view control passes this value to the application-defined comparison function. You can also use the LVM_FINDITEM message to search a list view control for an item with a specified lParam value.

Remarks

The LV_ITEM structure is used with a number of messages, including LVM_GETITEM, LVM_SETITEM, LVM_INSERTITEM, and LVM_DELETEITEM.

See Also

LVM_DELETEITEM, LVM_GETITEM, LVM_INSERTITEM, LVM_SETITEM