Share via


CListCtrl::GetGroupState

Retrieves the state for a specified group in the current list-view control.

UINT GetGroupState(
     int iGroupId, 
     DWORD dwMask
) const;

Parameters

Parameter

Description

[in] iGroupId

Zero-based index of a group.

[in] dwMask

Mask that specifies the state value to retrieve for the specified group. For more information, see the mask member of the LVGROUP structure.

Return Value

The requested state for the specified group, or 0 if the group cannot be found.

Remarks

The return value is the result of a bitwise AND operation on the dwMask parameter and the value of the state member of an LVGROUP structure that represents the current list-view control.

This method sends the LVM_GETGROUPSTATE message, which is described in the Windows SDK. For more information, see the ListView_GetGroupState macro.

Requirements

Header: afxcmn.h

This control is supported in Windows Vista and later.

Additional requirements for this method are described in Build Requirements for Windows Vista Common Controls.

See Also

Reference

CListCtrl Class

Hierarchy Chart

LVM_GETGROUPSTATE

LVGROUP

ListView_GetGroupState