ListView_GetItemIndexRect macro (commctrl.h)

Gets the bounding rectangle for all or part of a subitem in the current view of a specified list-view control. Use this macro or send the LVM_GETITEMINDEXRECT message explicitly.

Syntax

BOOL ListView_GetItemIndexRect(
  [in]      HWND        hwnd,
  [in]      LVITEMINDEX *plvii,
  [in]      LONG        iSubItem,
  [in]      LONG        code,
  [in, out] LPRECT      prc
);

Parameters

[in] hwnd

Type: HWND

A handle to the list-view control.

[in] plvii

Type: LVITEMINDEX*

A pointer to a LVITEMINDEX structure for the parent item of the subitem. The caller is responsible for allocating this structure and setting its members. plvii must not be NULL.

[in] iSubItem

Type: LONG

The index of the subitem.

[in] code

Type: LONG

The portion of the list-view subitem for which to retrieve the bounding rectangle. This parameter must be one of the following values.

Value Meaning
LVIR_BOUNDS
Returns the bounding rectangle of the entire subitem, including the icon and label.
LVIR_ICON
Returns the bounding rectangle of the icon or small icon of the subitem.
LVIR_LABEL
Returns the bounding rectangle of the subitem text.

[in, out] prc

Type: LPRECT

A pointer to a RECT structure to receive the coordinates. The caller is responsible for allocating this structure. prc must not be NULL.

Return value

Type: BOOL

Returns TRUE if successful, or FALSE otherwise.

Remarks

If iSubItem is zero, this macro returns the coordinates of the rectangle to the item pointed to by plvii. The value LVIR_SELECTBOUNDS for the parameter code is not supported.

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