Edit

NMTBGETINFOTIPA structure (commctrl.h)

  • Article

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

Syntax

typedef struct tagNMTBGETINFOTIPA {
  NMHDR  hdr;
  LPSTR  pszText;
  int    cchTextMax;
  int    iItem;
  LPARAM lParam;
} NMTBGETINFOTIPA, *LPNMTBGETINFOTIPA;

Members

hdr

Type: NMHDR

NMHDR structure that contains additional information about the notification.

pszText

Type: LPTSTR

Address of a character buffer that receives the infotip text.

cchTextMax

Type: int

Size of the buffer, in characters, at pszText. In most cases, the buffer will be INFOTIPSIZE characters in size, but you should always make sure that your application does not copy more than cchTextMax characters to the buffer at pszText.

iItem

Type: int

The command identifier of the item for which infotip information is being requested. This member is filled in by the control before sending the notification code.

lParam

Type: LPARAM

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

Remarks

Note

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