Windows Dev Center

Edit_GetCueBannerText macro

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 lpcwText,
   LONG    cchText
);

Parameters

hwnd

Type: HWND

A handle to the edit control.

lpcwText

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

If the macro succeeds, it returns TRUE. Otherwise it returns FALSE.

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Commctrl.h

See also

Reference
EM_GETCUEBANNER
Conceptual
Edit Controls

 

 

Community Additions

ADD
Show:
© 2015 Microsoft