ListView_GetItem

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

BOOL ListView_GetItem( 
  HWND hwnd, 
  LVITEM FAR* pitem 
);

Parameters

  • hwnd
    Handle to the list-view control.
  • pitem
    Pointer to an LVITEM 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 LVITEM structure.

    If the mask member specifies the LVIF_TEXT value, the pszText member must contain the address of 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 must specify the item state bits to retrieve. On output, the state member contains the values of the specified state bits.

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

Related message: LVM_GETITEM

Requirements

Header commctrl.h
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

LVM_GETITEM
List-View Controls Macros