ListView_GetItem

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library

Header File
commctrl.h
Unicode
WinNT
Platform Notes
None

The ListView_GetItem macro retrieves some or all of a list view item's attributes. You can use this macro or explicitly send the LVM_GETITEM message.

BOOL ListView_GetItem(

HWND hwnd,
LV_ITEM FAR *pitem
);

Parameters
hwnd

Handle to the list view control.

pitem

Pointer to an LV_ITEM structure that specifies the information to retrieve and receives information about the list view item.

When the LVM_GETITEM message is sent, the iItem and iSubItem members identify the item or subitem to retrieve information about and the mask member specifies which attributes to retrieve. For a list of possible values, see the description of the LV_ITEM structure.

If the mask member specifies the LVIF_TEXT value, the pszText member must contain the pointer to the buffer that receives the item text and the cchTextMax member must specify the size of the buffer.

If the mask member specifies the LVIF_STATE value, the stateMask member specifies which item states are to be returned.

Return Values
Returns TRUE if successful or FALSE otherwise.