BCM_GETNOTELENGTH message

Gets the length of the note text that may be displayed in the description for a command link button. Send this message explicitly or by using the Button_GetNoteLength macro.

Parameters

wParam

Must be zero.

lParam

Must be zero.

Return value

Returns the length of the note text in WCHARs, not including any terminating NULL, or zero if there is no note text.

Remarks

Beginning with comctl32 DLL version 6.01, command link buttons may have a note. For information on DLL versions, see Common Control Versions.

The BCM_GETNOTELENGTH message works only with the BS_COMMANDLINK and BS_DEFCOMMANDLINK button styles.

Requirements

Requirement Value
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