Header_GetItem macro (commctrl.h)

Article
10/23/2024

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

Syntax

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

Parameters

hwndHD

Type: HWND

A handle to the header control.

i

Type: int

The index of the item for which information is to be retrieved.

phdi

Type: LPHDITEM

A 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 value

Type: BOOL

Returns TRUE if successful, or FALSE otherwise.

Remarks

If the HDI_TEXT flag is set in the mask member of the HDITEM structure, the control may change the pszText member of the structure to point to the new text instead of filling the buffer with the requested text. Applications should not assume that the text will always be placed in the requested buffer.

The Header_GetItem macro is defined as follows:

#define Header_GetItem(hwndHD, i, phdi)      \

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

    (WPARAM)(int)(i), (LPARAM)(LPHDITEM)(phdi))

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