Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This macro retrieves information about a tab in a tab control. You can use this macro or send the TCM_GETITEMmessage explicitly.

Syntax 

BOOL TabCtrl_GetItem( 
  HWND 
hwnd, 
  int 
iItem, 
  TCITEM FAR* 
pitem 
);

Parameters

hwnd

Handle to the tab control.

iItem

Index of the tab.

pitem

Pointer to a TCITEMstructure that specifies the information to retrieve and receives information about the tab. When the message is sent, the maskmember specifies which attributes to return.

If the maskmember specifies the TCIF_TEXT value, the pszTextmember must contain the address of the buffer that receives the item text, and the cchTextMaxmember must specify the size of the buffer.

Return Value

TRUE indicates success. FALSE indicates failure.

Requirements

Header commctrl.h
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

TCM_GETITEM
TCITEM