TabCtrl_GetItem

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library

Header File
commctrl.h
Unicode
WinNT
Platform Notes
None

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

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 TC_ITEM 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
Returns TRUE if successful or FALSE otherwise.