CHeader.GetItemmethod

Gets information about an item in a header control.

WindowsmethodCHeader.incdocumented

Syntax

FUNCTION GetItem (BYVAL hHeader AS HWND, BYVAL i AS DWORD, BYVAL phdi AS HDITEMW PTR) AS BOOLEAN

FUNCTION GetItem (BYVAL hHeader AS HWND, BYVAL i AS DWORD, BYREF hdi AS HDITEMW) AS BOOLEAN

FUNCTION GetItem (BYVAL hHeader AS HWND, BYVAL i AS DWORD) AS HDITEMW

Parameters

Name		Description
`hHeader`		The handle of the header control.
`i`		The index of the item for which information is to be retrieved.
`phdi`		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

Returns TRUE if successful, or FALSE otherwise.

Description

Gets information about an item in a header control.

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.

Reference

Include file CHeader.inc
Defined in AfxNova/CHeader.inc:188
Documented in Windows/WIndows Controls/CHeader Class.md
Topic: CHeader Class