CTabCtrl::GetItem

检索有关可选的信息在选项卡控件。

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

参数

  • nItem
    选项的从零开始的索引。

  • pTabCtrlItem
    TCITEM 结构的指针,用于指定信息检索。 还用于获取有关选项的信息。 此机制用于 InsertItemGetItemSetItem 成员函数。

返回值

返回 TRUE,如果成功;否则 FALSE

备注

当发送时信息,mask 成员指定要返回的属性。 如果 mask 成员指定 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 framework之间的差别应等于的额外字节数。每个选项。

示例

// 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();
}

要求

Header: afxcmn.h

请参见

参考

CTabCtrl选件类

层次结构图

CTabCtrl::InsertItem

CTabCtrl::SetItem