BCM_GETNOTE message

Gets the text of the note associated with a command link button. You can send this message explicitly or use the Button_GetNote macro.

Parameters

wParam [in, out]

A DWORD that specifies the size of the buffer pointed to by lParam, in characters.

lParam [out]

The string buffer to receive the text. The buffer must be large enough to accommodate the terminating NULL character.

Return value

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

Remarks

The BCM_GETNOTE message works only with buttons that have the BS_COMMANDLINK or BS_DEFCOMMANDLINK button style.

GetLastError will contain:

  • ERROR_NOT_SUPPORTED, if the button does not have the BS_DEFCOMMANDLINK or BS_COMMANDLINK style.
  • ERROR_INSUFFICIENT_BUFFER, if the lParam buffer is too small. The wParam parameter will contain the required buffer size, in characters.

Requirements

Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2008 [desktop apps only]
Header
Commctrl.h

See also

Reference

Button Styles

Conceptual

Button Types