CTabCtrl::GetItem

Artículo
06/10/2015

Información de recupera sobre una pestaña de un control de ficha.

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

Parámetros

nItem
índice basado en cero de la pestaña.
pTabCtrlItem
Puntero a una estructura de TCITEM , se usa para especificar la información para recuperar. También se utiliza para recibir información sobre la ficha. esta estructura se utiliza con InsertItem, GetItem, y el miembro de SetItem funciona.

Valor devuelto

devuelve TRUE si correctamente; FALSO de otra manera.

Comentarios

Cuando se envía el mensaje, el miembro de máscara especifica que los atributos que se van a devolver. Si el miembro de máscara especifica el valor de TCIF_TEXT , el miembro de pszText debe contener la dirección del búfer que recibe el texto del elemento y el miembro de cchTextMax debe especificar el tamaño de búfer.

máscara
Valor que especifica qué miembros de la estructura de TCITEM para recuperar o establecer. Este miembro puede ser cero o una combinación de los siguientes valores:
- El miembro deTCIF_TEXT The pszText es válido.
- El miembro deTCIF_IMAGE The iImage es válido.
- El miembro deTCIF_PARAM The lParam es válido.
- El texto deTCIF_RTLREADING speed pszText se muestran mediante derecha a izquierda en sistemas hebreos o árabes.
- El miembro deTCIF_STATE The dwState es válido.
pszText
Puntero a una cadena terminada en null que contiene el texto de la pestaña si la estructura contiene información sobre una pestaña. Si la estructura está recibiendo información, este miembro especifica la dirección del búfer que recibe el texto de la pestaña.
cchTextMax
El tamaño del búfer al que pszText. Omiten este miembro si la estructura no está recibiendo información.
iImage
Índice en la lista del control de ficha, o – 1 si no hay ninguna imagen de la pestaña.
lParam
Datos definidos por la aplicación asociada con la pestaña. Si hay más de cuatro bytes de datos definidos por la aplicación para la pestaña, una aplicación debe definir una estructura y utilizarla en lugar de la estructura de TCITEM . El primer miembro de la estructura definida por la aplicación debe ser una estructura de TCITEMHEADER. la estructura de TCITEMHEADER es idéntica a la estructura de TCITEM , pero sin el miembro de lParam . La diferencia entre el tamaño de la estructura y el tamaño de la estructura de TCITEMHEADER debe ser igual al número de bytes adicionales en la pestaña.

Ejemplo

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