Header_GetItem

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library

Header File
commctrl.h
Unicode
WinNT
Platform Notes
None

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

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 HD_ITEM 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
If the operation succeeds, the return value is TRUE.

If the operation fails, the return value is FALSE.

Remarks
The Header_GetItem macro is defined as follows:

#define Header_GetItem(hwndHD, index, phdi) \

(BOOL)SendMessage((hwndHD), HDM_GETITEM, \

(WPARAM)(int)(index), (LPARAM)(HD_ITEM FAR*)(phdi))