CTabCtrl::GetItem

2011-08-09

タブコントロールのタブに関する情報を取得します。

BOOL GetItem(
  int nItem,
  TCITEM* pTabCtrlItem 
) const;

パラメーター

nItem
タブの 0 から始まるインデックス。
pTabCtrlItem
取得する情報の指定に使う TCITEM 構造体へのポインター。タブの情報を受け取るためにも使います。この構造体はメンバー関数 InsertItem、GetItem、および SetItem で使います。

戻り値

正常終了した場合は TRUE を、それ以外の場合は FALSE を返します。

解説

mask メンバーは、メッセージが送られたときに返す属性を指定します。 mask メンバーが TCIF_TEXT 値を指定しているときは、pszText メンバーはアイテムのテキストを受け取るバッファーのアドレスを保持しており、cchTextMax メンバーはバッファーのサイズを指定します。

mask
取得または設定する TCITEM 構造体メンバーを指定する値。このメンバーには 0、または次の値の組み合わせを指定できます。
- TCIF_TEXT pszText メンバーが有効です。
- TCIF_IMAGE iImage メンバーが有効です。
- TCIF_PARAM lParam メンバーが有効です。
- TCIF_RTLREADING ヘブライ語またはアラビア語のシステムでは、pszText のテキストが右から左の順に表示されます。
- TCIF_STATE dwState メンバーが有効です。
pszText
構造体がタブについての情報を保持しているときは、タブのテキストを持つ NULL で終わる文字列へのポインター。構造体が情報を受け取るときは、このメンバーはタブのテキストを受け取るバッファーのアドレスを指定します。
cchTextMax
pszText が指すバッファーのサイズ。構造体が情報を受け取らないときは、このメンバーは無視されます。
iImage
タブコントロールのイメージリスト内のインデックス。タブにイメージがないときは -1。
lParam
タブに関連付けられたアプリケーション定義のデータ。タブごとのアプリケーション定義のデータが 4 バイト以上あるときは、アプリケーションで構造体を定義し、TCITEM 構造体の代わりに使います。アプリケーション定義の構造体の先頭のメンバーは、TCITEMHEADER 構造体とする必要があります。 TCITEMHEADER 構造体は TCITEM 構造体と同じですが、lParam メンバーを持っていません。アプリケーション定義の構造体のサイズと TCITEMHEADER 構造体のサイズの差は、タブごとの補足バイト数に一致します。

使用例

// In this example a CTabCtrl data member, m_TabCtrl, changes the
// text of the tabs in the tab control.  A call to GetItem is used
// to get the current text, and then the text is changed.  A call 
// to SetItem is used to update the tab with the new text.

void CTabDlg::OnChangeItem()
{
   TCITEM tcItem;
   CString pszString;

   //  Get text for the tab item.
   GetDlgItemText(IDC_ITEM_TEXT, pszString);

   //  Get the current tab item text.
   TCHAR buffer[256] = {0};
   tcItem.pszText = buffer;
   tcItem.cchTextMax = 256;
   tcItem.mask = TCIF_TEXT;
   m_TabCtrl.GetItem(0, &tcItem);
   TRACE(_T("Changing item text from %s to %s..."), tcItem.pszText, pszString);

   //  Set the new text for the item.
   tcItem.pszText = pszString.LockBuffer();

   //  Set the item in the tab control.
   m_TabCtrl.SetItem(0, &tcItem);

   pszString.UnlockBuffer();
}