ComboBox_GetCueBannerText macro

Gets the cue banner text displayed in the edit control of a combo box. Use this macro or send the CB_GETCUEBANNER message explicitly.

Syntax


BOOL ComboBox_GetCueBannerText(
  HWND hwnd,
  LPWSTR lpwText,
  int cchText
);

Parameters

hwnd

Type: HWND

A handle to the combo box.

lpwText

Type: LPWSTR

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.

cchText

Type: int

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

Return value

Returns TRUE if successful, or an error value otherwise.

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

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Commctrl.h

See also

Combo Box Features

 

 

Community Additions

ADD
Show:
© 2014 Microsoft