Header_InsertItem

This macro inserts a new item into a header control. You can use this macro or send the HDM_INSERTITEM message explicitly.

At a Glance

Header file: Commctrl.h
Windows CE versions: 1.0 and later
Related message: HDM_INSERTITEM

Syntax

int Header_InsertItem( hwndHD, index, phdi );

Parameters

hwndHD

Handle to the header control.

index

Index of the item after which the new item is to be inserted. The new item is inserted at the end of the header control if index is greater than or equal to the number of items in the control. If index is zero, the new item is inserted at the beginning of the header control.

phdi

Pointer to an HDITEM structure that contains information about the new item.

Return Values

The index of the new item indicates success. –1 indicates failure.

Remarks

The Header_InsertItem macro is defined as follows:

#define Header_InsertItem(hwndHD, index, phdi)   \
   (int)SendMessage((hwndHD), HDM_INSERTITEM, (WPARAM)(int)(index), \
   (LPARAM)(const LPHDITEM)(phdi))