Edit

Share via

ListView_GetGroupInfoByIndex macro (commctrl.h)

  • Article

Gets information on a specified group. Use this macro or send the LVM_GETGROUPINFOBYINDEX message explicitly.

Syntax

LRESULT ListView_GetGroupInfoByIndex(
  [in]      HWND     hwnd,
  [in]      int      iIndex,
  [in, out] PLVGROUP pgrp
);

Parameters

[in] hwnd

Type: HWND

A handle to the list-view control.

[in] iIndex

Type: int

The index of the group.

[in, out] pgrp

Type: PLVGROUP

A pointer to an LVGROUP structure to receive information on the group specified by iIndex. The calling application is responsible for allocating memory for the structure and any buffers in the structure, such as, the one pointed to by pszHeader. Set any contingent members of the structure, such as, cchHeader—the size of the buffer pointed to by pszHeader in WCHARs, including the terminating NULL. Set cbSize to the size of LVGROUP in bytes.

The message receiver is responsible for setting the structure members with information for the group specified by iIndex.

Return value

Type: LRESULT

Returns 1 if successful, or 0 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