TabCtrl_GetItem

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

At a Glance

Header file: Commctrl.h
Windows CE versions: 1.0 and later
Related message: TCM_GETITEM

Syntax

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

Parameters

hwnd

Handle to the tab control.

iItem

Index of the tab.

pitem

Pointer to a TCITEM structure that specifies the information to retrieve and receives information about the tab. When the message is sent, the mask member specifies which attributes to return.

If the mask member specifies the TCIF_TEXT value, the pszText member must contain the address of the buffer that receives the item text, and the cchTextMax member must specify the size of the buffer.

Return Values

TRUE indicates success. FALSE indicates failure.