CListCtrl::GetGroupInfoByIndex

检索有关指定组的信息的列表视图控件的。

BOOL GetGroupInfoByIndex(
     int iIndex, 
     PLVGROUP pGroup
) const;

参数

Parameter

说明

[in] iIndex

组的从零开始的索引。

[out] pGroup

为获取有关组的信息的 LVGROUP 结构的指针由 iIndex 参数指定了。

调用方负责初始化 LVGROUP 结构的成员。 设置 cbSize 成员指向结构的大小和 mask 成员的标志指定信息检索。

返回值

true,则此方法成功;否则,false。

备注

此方法发送 LVM_GETGROUPINFOBYINDEX 信息,在 Windows SDK所述。

要求

标头: afxcmn.h

此控件在 Windows Vista 和更高版本支持。

此方法的其他要求。Windows vista公共控件的生成要求所述。

示例

下面的代码示例定义一个变量,m_listCtrl,用于访问当前列表视图控件。 此变量在下一个示例。

public:
    // Variable used to access the list control.
    CListCtrl m_listCtrl; 

下面的代码示例演示 GetGroupInfoByIndex 方法。 此代码示例的早期部分我们创建了显示两列标题为“ClientID”和“层”在"报告"视图中的列表视图控件。 下面的代码示例检索有关索引为0的组的信息,因此,如果此组存在。

    // GetGroupInfoByIndex
    const int GROUP_HEADER_BUFFER_SIZE = 40;

// Initialize the structure 
    LVGROUP gInfo = {0};
    gInfo.cbSize = sizeof(LVGROUP);
    wchar_t wstrHeadGet[GROUP_HEADER_BUFFER_SIZE] = {0};
    gInfo.cchHeader = GROUP_HEADER_BUFFER_SIZE;
    gInfo.pszHeader = wstrHeadGet;
    gInfo.mask = (LVGF_ALIGN | LVGF_STATE | LVGF_HEADER | LVGF_GROUPID);
    gInfo.state = LVGS_NORMAL;
    gInfo.uAlign  = LVGA_HEADER_LEFT;

    BOOL bRet = m_listCtrl.GetGroupInfoByIndex( 0, &gInfo );
    if (bRet == TRUE) {
        CString strHeader = CString( gInfo.pszHeader );
        CString str;
        str.Format(_T("Header: '%s'"), strHeader);
        AfxMessageBox(str, MB_ICONINFORMATION);
    }
    else
    {
        AfxMessageBox(_T("No group information was retrieved."));
    }

请参见

参考

CListCtrl选件类

层次结构图

LVM_GETGROUPINFOBYINDEX

LVGROUP