Header_GetItem

This macro retrieves information about an item in a header control. You can use this macro or send the HDM_GETITEM message explicitly.

At a Glance

Syntax

BOOL Header_GetItem( hwndHD, index, phdi );

Parameters

hwndHD

Handle to the header control.

index

Index of the item for which information is to be retrieved.

phdi

Pointer to an HDITEM structure. When the message is sent, the mask member indicates the type of information being requested. When the message returns, the other members receive the requested information. If the mask member specifies zero, the message returns TRUE but copies no information to the structure.

Return Values

TRUE indicates success. FALSE indicates failure.

Remarks

The Header_GetItem macro is defined as follows:

#define Header_GetItem(hwndHD, index, phdi)      \
   (BOOL)SendMessage((hwndHD), HDM_GETITEM,      \
   (WPARAM)(int)(index), (LPARAM)(LPHDITEM)(phdi))