TBN_GETBUTTONINFO

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library
-
Header File
commctrl.h
Unicode
WinNT
Platform Notes
None

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

TBN_GETBUTTONINFO

ptbn = (TBNOTIFY FAR *) lParam;

Parameters
ptbn
Pointer to a TBNOTIFY structure. The iItem member specifies a zero-based index that provides a count of the buttons the customize 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 Values
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.