Edit

Share via

ListView_GetGroupRect macro (commctrl.h)

  • Article

Gets the rectangle for a specified group. Use this macro or send the LVM_GETGROUPRECT message explicitly.

Syntax

BOOL ListView_GetGroupRect(
  [in]      HWND hwnd,
  [in]      int  iGroupId,
  [in]      LONG type,
  [in, out] RECT *prc
);

Parameters

[in] hwnd

Type: HWND

A handle to the list-view control.

[in] iGroupId

Type: int

Specifies the group by iGroupId (see LVGROUP structure).

[in] type

Type: LONG

Specifies the type of rectangle to retrieve. This parameter must be one of the following values.

Value Meaning
LVGGR_GROUP
 Coordinates of the entire expanded group.
LVGGR_HEADER
 Coordinates of the header only (collapsed group).
LVGGR_LABEL
 Coordinates of the label only.
LVGGR_SUBSETLINK
 Coordinates of the subset link only (markup subset). A list-view control can limit the number of visible items displayed in each group. A link is presented to the user to allow the user to expand the group. This flag will return the bounding rectangle of the subset link if the group is a subset (group state of LVGS_SUBSETED, see structure LVGROUP, member state). This flag is provided so that accessibility applications can locate the link.

[in, out] prc

Type: RECT*

A pointer to a RECT structure to receive information on the group specified by iGroupId. The message receiver is responsible for setting the structure members with information for the group specified by iGroupId. The calling application is responsible for allocating memory for the structure.

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