CListCtrl::GetGroupInfoByIndex
更新 : 2007 年 11 月
現在のリスト ビュー コントロール内の指定されたグループに関する情報を取得します。
BOOL GetGroupInfoByIndex(
int iIndex,
PLVGROUP pGroup
) const;
パラメータ
パラメータ |
説明 |
|---|---|
[入力] iIndex |
グループの 0 から始まるインデックス。 |
[出力] pGroup |
iIndex パラメータで指定されているグループに関する情報を受け取る LVGROUP 構造体へのポインタ。 呼び出し元は、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" および "Grade" というタイトルの 2 つの列をレポート ビューに表示するリスト ビュー コントロールを作成しました。次のコード例では、インデックスが 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."));
}