Edit

Share via

ListView_GetGroupState macro (commctrl.h)

  • Article

Gets the state for a specified group. Use this macro or send the LVM_GETGROUPSTATE message explicitly.

Syntax

UINT ListView_GetGroupState(
  [in] HWND hwnd,
  [in] UINT dwGroupId,
  [in] UINT dwMask
);

Parameters

[in] hwnd

Type: HWND

A handle to the list-view control.

[in] dwGroupId

Type: UINT

Specifies the group by iGroupId (see LVGROUP structure).

[in] dwMask

Type: UINT

Specifies the state values to retrieve. This is a combination of the flags listed for the state member of LVGROUP.

Return value

Type: UINT

Returns the combination of state values that are set. For example, if dwMask is LVGS_COLLAPSED and the value returned is zero, the LVGS_COLLAPSED state is not set. Zero is returned if the group is not found.

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