CListCtrl::GetGroupInfoByIndex
現在のリスト ビュー コントロールの特定のグループについての情報を取得します。
BOOL GetGroupInfoByIndex(
int iIndex,
PLVGROUP pGroup
) const;
パラメーター
パラメーター |
説明 |
|---|---|
[入力] iIndex |
グループのインデックス。 |
[出力] pGroup |
グループに関する情報を受け取る LVGROUP の構造体へのポインターは、iIndex のパラメーターで指定されています。 呼び出し元は LVGROUP の構造体のメンバーの初期化があります。情報を取得するように指定するには、構造体のサイズに cbSize のメンバー、および mask のメンバーでフラグを設定します。 |
戻り値
このメソッドが成功した場合は true。それ以外の場合は false。
解説
このメソッドは Windows SDKで説明する LVM_GETGROUPINFOBYINDEX のメッセージを送信します。
必要条件
ヘッダー: afxcmn.h
このコントロールは Windows Vista 以降でサポートされます。
このメソッドに関するその他の要件については、「Windows Vista コモン コントロールの作成要件」を参照してください。
使用例
次のコード例は、現在のリスト ビュー コントロールへのアクセスに使用される変数、m_listCtrlを定義します。この変数は次のように使用されます。
public:
// Variable used to access the list control.
CListCtrl m_listCtrl;
GetGroupInfoByIndex メソッドのコード例を次に示します。このコード例では、前のセクションでは、表示が 2 列「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."));
}