Edit_GetCueBannerText macro (commctrl.h)
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
BOOL Edit_GetCueBannerText(
HWND hwnd,
LPCWSTR lpwText,
LONG 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 lpwText.
Return value
Type: BOOL
If the macro succeeds, it returns TRUE. Otherwise it returns FALSE.
Remarks
Note To use this macro, you must provide a manifest specifying Comctl32.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 |
See also
Conceptual
Reference