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 structure specifies or receives the attributes of a tab item. It is used with the TCM_INSERTITEM, TCM_GETITEM, and TCM_SETITEMmessages.

Syntax 

typedef struct tagTCITEM { 
  UINT 
mask;
  DWORD 
dwState;
  DWORD 
dwStateMask;
  LPTSTR 
pszText;
  int 
cchTextMax ;
  int 
iImage;
  LPARAM 
lParam;
} TCITEM;

Members

mask

Specifies which members to retrieve or set. It can be a combination of the following values.

Value Description

TCIF_IMAGE

The iImagemember is valid.

TCIF_PARAM

The lParammember is valid.

TCIF_RTLREADING

The text of pszTextis displayed using right-to-left reading order on Hebrew or Arabic systems.

TCIF_STATE

The dwStatemember is valid.

TCIF_TEXT

The pszTextmember is valid.
dwState

Specifies the item's current state if information is being retrieved. If item information is being set, this member contains the state value to be set for the item. For a list of valid tab control item states, see Tab Control Item States.

dwStateMask

Specifies which bits of the dwStatemember are valid.

pszText

Pointer to a null-terminated string that contains the tab text when item information is being set. If item information is being retrieved, this member specifies the address of the buffer that receives the tab text.

cchTextMax

Size of the buffer pointed to by the pszTextmember. If the structure is not receiving information, this member is ignored.

iImage

Index into the tab control's image list, or -1 if there is no image for the tab.

lParam

Application-defined data associated with the tab control item. If more or less than 4 bytes of application-defined data exist per tab, an application must define a structure and use it instead of the TCITEMstructure. The first member of the application-defined structure must be a TCITEMHEADERstructure.

Requirements

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

See Also