CListCtrl::GetGroupInfoByIndex
擷取所指定之群組的資訊會儲存在目前清單檢視控制項。
BOOL GetGroupInfoByIndex(
int iIndex,
PLVGROUP pGroup
) const;
參數
參數 |
描述 |
|---|---|
[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."));
}