CTabCtrl::GetItem

發行項
02/28/2013

擷取與一個索引標籤的資訊在索引標籤控制項。

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

參數

nItem
選取項目之以零起始的索引。
pTabCtrlItem
為 TCITEM 結構的指標，用來指定要擷取資訊。也可用來取得有關選項的資訊。這個結構會與 InsertItem、 GetItem和 SetItem 成員函式。

傳回值

傳回，如果失敗，是否則否。

備註

傳送訊息時，遮罩成員會指定要傳回哪些屬性。如果遮罩成員指定 TCIF_TEXT 值， pszText 成員必須包含接收項目文字，並 cchTextMax 成員必須指定緩衝區大小的緩衝區的位址。

Mask - 遮罩
值指定擷取或設定哪些 TCITEM 結構成員。成員可以是零或下列值的組合:
- TCIF_TEXTpszText 成員有效。
- TCIF_IMAGEiImage 成員有效。
- TCIF_PARAMlParam 成員有效。
- 使用在希伯來文或阿拉伯文系統，以從右至左的讀取順序TCIF_RTLREADINGpszText 文字顯示。
- TCIF_STATEdwState 成員有效。
pszText
含有索引標籤文字的 NULL 結尾字串的指標，如果結構包含有關選項的資訊。如果結構會收到訊息，這個成員會指定接收索引標籤文字緩衝區的位址。
cchTextMax
緩衝區大小所指向的 pszText。如果兩個結構不會收到訊息，這個成員會被忽略。
iImage
索引標籤控制項的影像清單中，則為 1。如果沒有索引標籤上的影像。
lParam
應用程式定義的資料與索引標籤。如果超過四位元組應用程式定義之資料的每個索引標籤，應用程式必須定義結構和使用而不是 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();
}