CHeader.GetTextmethod
Gets the text of the specified column.
Syntax
FUNCTION GetText (BYVAL hHeader AS HWND, BYVAL iItem AS LONG, BYVAL pwszText AS WSTRING PTR, BYVAL cchTextMax AS LONG = MAX_PATH + 1) AS BOOLEAN
FUNCTION GetText (BYVAL hHeader AS HWND, BYVAL iItem AS LONG) AS DWSTRING
Also documented as
GetItemText — one description covers them all.Parameters
| Name | Description | |
|---|---|---|
hHeader | The handle of the header control. | |
iItem | The zero-based index of the header control item for which to retrieve the text. | |
pwszText | A pointer to an item string. If the text is being retrieved from the control, this member must be initialized to point to a character buffer. If this member is set to LPSTR_TEXTCALLBACK, the control will request text information for this item by sending an HDN_GETDISPINFO notification code. Note that although the header control allows a string of any length to be stored as item text, only the first 260 characters are displayed. | |
cchTextMax | Maximum number of characters to return. Both this value and the size of the buffer pointed by pwszText must be one character bigger that the wanted length of the text to return to make room for the null character terminator. |
Return value
Returns TRUE if successful, or FALSE otherwise.
The second overlodes method returns the retrieved text.
Description
Gets the text of the specified column.
Reference
- Include file
CHeader.inc - Defined in AfxNova/CHeader.inc:306
- Documented in Windows/WIndows Controls/CHeader Class.md
- Topic: CHeader Class