Button_GetNoteLength

Button_GetNoteLength macro

Gets the length of the note text that may be displayed in the description for a command link. Use this macro or send the BCM_GETNOTELENGTH message explicitly.

Syntax


LRESULT Button_GetNoteLength(
  [in] HWND hwnd
);

Parameters

hwnd [in]

Type: HWND

A handle to the button control.

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 Button_GetNoteLength macro works only with the BS_COMMANDLINK and BS_DEFCOMMANDLINK button styles.

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

 

 

Show:
© 2016 Microsoft