NMTOOLBARA structure (commctrl.h)

  • Article

Contains information used to process toolbar notification codes. This structure supersedes the TBNOTIFY structure.

Syntax

typedef struct tagNMTOOLBARA {
  NMHDR    hdr;
  int      iItem;
  TBBUTTON tbButton;
  int      cchText;
  LPSTR    pszText;
  RECT     rcButton;
} NMTOOLBARA, *LPNMTOOLBARA;

Members

hdr

Type: NMHDR

NMHDR structure that contains additional information about the notification.

iItem

Type: int

Command identifier of the button associated with the notification code.

tbButton

Type: TBBUTTON

TBBUTTON structure that contains information about the toolbar button associated with the notification code. This member only contains valid information with the TBN_QUERYINSERT and TBN_QUERYDELETE notification codes.

cchText

Type: int

Count of characters in the button text.

pszText

Type: LPTSTR

Address of a character buffer that contains the button text.

rcButton

Type: RECT

Version 5.80. A RECT structure that defines the area covered by the button.

Remarks

Note

The commctrl.h header defines NMTOOLBAR as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header commctrl.h