TCM_GETITEM (Compact 2013)

  • Article

3/28/2014

This message retrieves information about a tab in a tab control. You can send this message explicitly or by using the TabCtrl_GetItem macro.

Syntax

TCM_GETITEM wParam = (WPARAM)(int) iItem; 
    lParam = (LPARAM)(TCITEM FAR *) pitem;

Parameters

  • 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 Value

TRUE indicates success. FALSE indicates failure.

Requirements

Header

commctrl.h

See Also

Reference

Tab Controls Messages
TabCtrl_GetItem
TCITEM