TCITEM (Compact 2013)

3/28/2014

This structure specifies or receives the attributes of a tab item. It is used with the TCM_INSERTITEM, TCM_GETITEM, and TCM_SETITEM messages.

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 iImage member is valid.
  TCIF_PARAM	The lParam member is valid.
  TCIF_RTLREADING	The text of pszText is displayed using right-to-left reading order on Hebrew or Arabic systems.
  TCIF_STATE	The dwState member is valid.
  TCIF_TEXT	The pszText member 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 dwState member 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 pszText member. 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 TCITEM structure. The first member of the application-defined structure must be a TCITEMHEADER structure.

Requirements

See Also

Reference

Tab Controls Structures
TCM_INSERTITEM
TCM_GETITEM
TCM_SETITEM
TCITEMHEADER