Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Sets the text that is displayed as the textual cue, or tip, for an edit control. You can use this macro or send the EM_SETCUEBANNER message explicitly.
Syntax
BOOL Edit_SetCueBannerText(
HWND hwnd,
LPCWSTR lpcwText
);
Parameters
hwnd
Type: HWND
A handle to the edit control.
lpcwText
Type: LPCWSTR
A pointer to a Unicode string that contains the text to set as the textual cue.
Return value
Type: BOOL
If the macro succeeds, it returns TRUE. Otherwise it returns FALSE.
Remarks
An edit control that is used to begin a search may display "Enter search here" in gray text as a textual cue. When the user clicks the text, the text goes away and the user can type.
You cannot set a cue banner on a multiline edit control.
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