Compartilhar via


CListCtrl::GetGroupInfoByIndex

Recupera informações sobre um agrupar especificado no controle de exibição de lista corrente.

BOOL GetGroupInfoByIndex(
          int iIndex, 
     PLVGROUP pGroup
) const;

Parâmetros

Parâmetro

Descrição

[in] iIndex

Índice baseado em zero de um agrupar.

[out] pGroup

Ponteiro para um LVGROUP estrutura que recebe informações sobre o agrupar especificado pelo iIndex parâmetro.

O chamador é responsável por inicializar os membros do LVGROUP estrutura.conjunto o cbSize membro para o dimensionar da estrutura e os sinalizadores da mask membro para especificar as informações para recuperar.

Valor de retorno

true Se esse método for bem-sucedida; caso contrário, false.

Comentários

Esse método envia o LVM_GETGROUPINFOBYINDEX mensagem, que é descrita no Windows SDK.

Requisitos

Cabeçalho: afxcmn.h

Este controle é suportado no Windows Vista e mais recente.

Requisitos adicionais para este método são descritos em compilação Requisitos para controles comuns do Windows Vista.

Exemplo

O exemplo de código a seguir define uma variável, m_listCtrl, que é usado para acessar o controle de exibição de lista corrente. Essa variável é usada no exemplo a seguir.

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

O exemplo de código a seguir demonstra o GetGroupInfoByIndex método. Em uma seção anterior deste código de exemplo que criar um controle de exibição de lista que exibe duas colunas intituladas "ClientID" e "classificação" em um modo de exibição de relatório.O exemplo de código a seguir recupera informações sobre o agrupar cujo índice é 0, se existir um agrupar.

 // 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."));
    }

Consulte também

Referência

Classe CListCtrl

Gráfico de hierarquia

LVM_GETGROUPINFOBYINDEX

LVGROUP

Outros recursos

CListCtrl membros