Edit

NMTBDISPINFOA structure (commctrl.h)

  • Article

Contains and receives display information for a toolbar item. This structure is used with the TBN_GETDISPINFO notification code.

Syntax

typedef struct {
  NMHDR     hdr;
  DWORD     dwMask;
  int       idCommand;
  DWORD_PTR lParam;
  int       iImage;
  LPSTR     pszText;
  int       cchText;
} NMTBDISPINFOA, *LPNMTBDISPINFOA;

Members

hdr

Type: NMHDR

NMHDR structure that contains additional information about the notification.

dwMask

Type: DWORD

Set of flags that indicate which members of this structure are being requested. This can be one or more of the following values.

Value Meaning
TBNF_IMAGE
 The item's image index is being requested. The image index must be placed in the iImage member.
TBNF_TEXT
 Not currently implemented.
TBNF_DI_SETITEM
 Set this flag when processing TBN_GETDISPINFO; the toolbar control will retain the supplied information and not request it again.

idCommand

Type: int

Command identifier of the item for which display information is being requested. This member is filled in by the control before it sends the notification code.

lParam

Type: DWORD_PTR

Application-defined value associated with the item for which display information is being requested. This member is filled in by the control before sending the notification code.

iImage

Type: int

Image index for the item.

pszText

Type: LPTSTR

Pointer to a character buffer that receives the item's text.

cchText

Type: int

Size of the pszText buffer, in characters.

Remarks

Note

The commctrl.h header defines NMTBDISPINFO 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