Header_SetItem macro (commctrl.h)

Article
10/23/2024

Sets the attributes of the specified item in a header control. You can use this macro or send the HDM_SETITEM message explicitly.

Syntax

BOOL Header_SetItem(
   HWND     hwndHD,
   int      i,
   LPHDITEM phdi
);

Parameters

hwndHD

Type: HWND

A handle to a header control.

i

Type: int

The current index of the item whose attributes are to be changed.

phdi

Type: LPHDITEM

A pointer to an HDITEM structure that contains item information. When this message is sent, the mask member of the structure must be set to indicate which attributes are being set.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

Remarks

The HDITEM structure that supports this macro supports item order and image list information. By using these members, you can control the order in which items are displayed and specify images to appear with items.

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

Share via