Edit

Share via

TBN_GETBUTTONINFO notification code

  • Article

Retrieves toolbar customization information and notifies the toolbar's parent window of any changes being made to the toolbar. This notification code is sent in the form of a WM_NOTIFY message.

TBN_GETBUTTONINFO 

    lpnmtb = (LPNMTOOLBAR) lParam;

Parameters

lParam

Pointer to an NMTOOLBAR structure. The iItem member specifies a zero-based index that provides a count of the buttons the Customize Toolbar dialog box displays as both available and present on the toolbar. The pszText member specifies the address of the current button text, and cchText specifies its length in characters. The application should fill the structure with information about the button.

Return value

Returns TRUE if button information was copied to the specified structure, or FALSE otherwise.

Remarks

The toolbar control allocates a buffer, and the receiver (parent window) must copy the text into that buffer. The cchText member contains the length of the buffer allocated by the toolbar when TBN_GETBUTTONINFO is sent to the parent window.

Requirements

Requirement Value
Minimum supported client
 Windows Vista [desktop apps only]
Minimum supported server
 Windows Server 2003 [desktop apps only]
Header
Commctrl.h
Unicode and ANSI names
 TBN_GETBUTTONINFOW (Unicode) and TBN_GETBUTTONINFOA (ANSI)