CComboBox::GetCueBanner
Gets the cue text that is displayed for a combo box control.
CString GetCueBanner() const;
BOOL GetCueBanner(
LPTSTR lpszText,
int cchText
) const;
Parameters
Parameter |
Description |
|---|---|
[out] lpszText |
Pointer to a buffer that receives the cue banner text. |
[in] cchText |
Size of the buffer that the lpszText parameter points to. |
Return Value
In the first overload, a CString object that contains the cue banner text if it exists; otherwise, a CString object that has zero length.
-or-
In the second overload, true if this method is successful; otherwise, false.
Remarks
Cue text is a prompt that is displayed in the input area of the combo box control. The cue text is displayed until the user provides input.
This method sends the CB_GETCUEBANNER message, which is described in the Windows SDK.
Requirements
Header: afxwin.h
This method is supported in Windows Vista and later.
Additional requirements for this method are described in Build Requirements for Windows Vista Common Controls.