Button_GetNote

Button_GetNote macro

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

Syntax


BOOL Button_GetNote(
   HWND    hwnd,
   LPCWSTR psz,
   int     pcc
);

Parameters

hwnd

Type: HWND

A handle to the button control.

psz

Type: LPCWSTR

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

pcc

Type: int

A pointer to the length of the note, in characters.

Return value

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

Remarks

This 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 2003 [desktop apps only]

Header

Commctrl.h

See also

Reference
Button Styles
Conceptual
Button Types

 

 

Show:
© 2016 Microsoft