Edit

Share via

ListView_GetFooterItem macro (commctrl.h)

  • Article

Gets information on a footer item for a specified list-view control. Use this macro or send the LVM_GETFOOTERITEM message explicitly.

Syntax

BOOL ListView_GetFooterItem(
  [in]      HWND         hwnd,
  [in]      UINT         iItem,
  [in, out] LVFOOTERITEM *pfi
);

Parameters

[in] hwnd

Type: HWND

A handle to the list-view control.

[in] iItem

Type: UINT

An index of the item.

[in, out] pfi

Type: LVFOOTERITEM*

A pointer to a LVFOOTERITEM structure to receive a value for the state and/or pszText members according to the value of the mask member. The caller is responsible for allocating this structure and setting its members to indicate to the receiver what information to return. For more information, see LVFOOTERITEM.

Return value

Type: BOOL

Returns TRUE if successful, or FALSE otherwise.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header commctrl.h