Edit

NMTVDISPINFOA structure (commctrl.h)

  • Article

Contains and receives display information for a tree-view item. This structure is identical to the TV_DISPINFO structure, but it has been renamed to follow current naming conventions.

Syntax

typedef struct tagTVDISPINFOA {
  NMHDR   hdr;
  TVITEMA item;
} NMTVDISPINFOA, *LPNMTVDISPINFOA;

Members

hdr

Type: NMHDR

NMHDR structure that contains information about this notification.

item

Type: TVITEM

TVITEM structure that identifies and contains information about the tree-view item. The mask member of the TVITEM structure specifies which information is being set or retrieved. It can be one or more of the following values:

Value Meaning
TVIF_CHILDREN
 The cChildren member specifies, or is to receive, a value that indicates whether the item has child items.
TVIF_IMAGE
 The iImage member specifies, or is to receive, the index of the item's nonselected icon in the image list.
TVIF_SELECTEDIMAGE
 The iSelectedImage member specifies, or is to receive, the index of the item's selected icon in the image list.
TVIF_TEXT
 The pszText member specifies the new item text or the address of a buffer that is to receive the item text. If the structure is receiving item text, you typically copy the text to the buffer pointed to by the pszText member of the TVITEM structure. However, you can return a string in the pszText member instead. If you do so, you cannot change or delete the string until the corresponding item text is deleted or until two additional TVN_GETDISPINFO notification codes have been sent.

Remarks

Note

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

See also

Reference

TVN_SETDISPINFO

WM_NOTIFY