Share via

TabCtrl_GetItem

  • Article

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

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.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Commctrl.h    

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

TCM_GETITEM, TCITEM

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.