Edit_GetCueBannerText macro (commctrl.h)

Article
02/22/2024

Gets the text that is displayed as a textual cue, or tip, in an edit control. You can use this macro or send the EM_GETCUEBANNER message explicitly.

Syntax

void Edit_GetCueBannerText(
   hwnd,
   lpwText,
   cchText
);

Parameters

hwnd

Type: HWND

A handle to the edit control.

lpwText

Type: LPCWSTR

A pointer to a Unicode string that receives the text that is set as the cue banner.

cchText

Type: LONG

A LONG that specifies the number of WCHARs in the string referenced by lpcwText.

Return value

None

Remarks

Note To use this macro, you must provide a manifest specifying Comclt32.dll version 6.0. For more information on manifests, see Enabling Visual Styles.

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