CB_GETCUEBANNER message

Gets the cue banner text displayed in the edit control of a combo box. Send this message explicitly or by using the ComboBox_GetCueBannerText macro.

Parameters

wParam [in]

A pointer to a Unicode string buffer that receives the cue banner text. The calling application is responsible for allocating the memory for the buffer. The buffer size must be equal to the length of the cue banner string in WCHARs, plus 1 for the terminating NULL WCHAR.

lParam [in]

The size of the buffer pointed to by lpcwText in WCHARs.

Return value

Returns 1 if successful, or an error value otherwise.

If there is no cue banner text to get, the return value is 0. If the calling application fails to allocate a buffer, or set lParam before sending this message, undefined behavior may result and the return value may not be reliable.

Requirements

See also

Combo Box Features