NMHDDISPINFO structure

Contains information used in handling HDN_GETDISPINFO notification codes.

Syntax


typedef struct tagNMHDDISPINFO {
  NMHDR  hdr;
  int    iItem;
  UINT   mask;
  LPTSTR pszText;
  int    cchTextMax;
  int    iImage;
  LPARAM lParam;
} NMHDDISPINFO, *LPNMHDDISPINFO;

Members

hdr

Type: NMHDR

NMHDR structure containing information about this notification code.

iItem

Type: int

The zero-based index of the item in the header control.

mask

Type: UINT

A set of bit flags specifying which members of the structure must be filled in by the owner of the header control. This value can be a combination of the following values:

ValueMeaning
HDI_TEXT

The pszText field must be filled in.

HDI_IMAGE

Version 4.70. The iImage field must be filled in.

HDI_LPARAM

The lParam field must be filled in.

HDI_DI_SETITEM

Version 4.70. A return value. Indicates that the header control should store the item information and not ask for it again.

 

pszText

Type: LPTSTR

A pointer to a null-terminated string containing the text that will be displayed for the header item.

cchTextMax

Type: int

The size of the buffer that pszText points to.

iImage

Type: int

The zero-based index of an image within the image list. The specified image will be displayed with the header item, but it does not take the place of the item's bitmap. If iImage is set to I_IMAGECALLBACK, the control requests image information for this item by using an HDN_GETDISPINFO notification code.

lParam

Type: LPARAM

An application-defined value to associate with the item.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Commctrl.h

Unicode and ANSI names

NMHDDISPINFOW (Unicode) and NMHDDISPINFOA (ANSI)

 

 

Show: