Edit

Share via

TabCtrl_HighlightItem macro (commctrl.h)

  • Article

Sets the highlight state of a tab item. You can use this macro or send the TCM_HIGHLIGHTITEM message explicitly.

Syntax

C++ 
BOOL TabCtrl_HighlightItem(
   HWND hwnd,
   INT  i,
   WORD fHighlight
);

Parameters

hwnd

Type: HWND

Handle to the tab control.

i

Type: INT

Zero-based index of a tab control item.

fHighlight

Type: WORD

Value specifying the highlight state to be set. If this value is nonzero, the tab is highlighted. If this value is zero, the tab is set to its default state.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

Remarks

In Comctl32.dll version 6.0, this macro has no visible effect when a theme is active.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header commctrl.h