Edit

Share via

NMTVGETINFOTIPA structure (commctrl.h)

  • Article

Contains and receives tree-view item information needed to display a tooltip for an item. This structure is used with the TVN_GETINFOTIP notification code.

Syntax

typedef struct tagNMTVGETINFOTIPA {
  NMHDR     hdr;
  LPSTR     pszText;
  int       cchTextMax;
  HTREEITEM hItem;
  LPARAM    lParam;
} NMTVGETINFOTIPA, *LPNMTVGETINFOTIPA;

Members

hdr

Type: NMHDR

NMHDR structure that contains information about this notification.

pszText

Type: LPTSTR

Address of a character buffer that contains the text to be displayed. If you want to change the text displayed in the tooltip, you will need to modify the contents of this buffer. The size of this buffer is specified by the cchTextMax structure.

cchTextMax

Type: int

Size of the buffer at pszText, in characters. Although you should never assume that this buffer will be of any particular size, the INFOTIPSIZE value can be used for design purposes.

hItem

Type: HTREEITEM

Tree handle to the item for which the tooltip is being displayed.

lParam

Type: LPARAM

Application-defined data associated with the item for which the tooltip is being displayed.

Remarks

Note

The commctrl.h header defines NMTVGETINFOTIP as an alias that 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 is 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