Button_SetNote macro

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

Syntax


BOOL Button_SetNote(
  HWND hwnd,
  PCWSTR psz
);

Parameters

hwnd

Type: HWND

A handle to the button control.

psz

Type: PCWSTR

A pointer to a null-terminated WCHAR string that contains the note.

Return value

Returns TRUE if successful, or FALSE otherwise.

Remarks

Beginning with comctl32 DLL version 6.01, command link buttons may have a note.

This macro works only with the BS_COMMANDLINK and BS_DEFCOMMANDLINK button styles.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Commctrl.h

See also

Reference
Button Styles
Conceptual
Button Types

 

 

Community Additions

ADD
Show:
© 2014 Microsoft