Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This structure contains information used in handling the TTN_GETDISPINFOmessage.

Syntax 

typedef struct tagNMTTDISPINFO {
  NMHDR 
hdr;
  LPTSTR 
lpszText;
  TCHAR 
szText[80];
  HINSTANCE 
hinst;
  UINT 
uFlags;
  LPARAM 
lParam;
} NMTTDISPINFO, FAR* LPNMTTDISPINFO;

Members

hdr

NMHDRstructure that contains additional information about the message.

lpszText

Pointer to a null-terminated string that the ToolTip displays as the ToolTip text. If hinstspecifies an instance handle, lpszTextmust be the identifier of a string resource.

szText

Buffer that receives the ToolTip text. An application can copy the text to this buffer instead of specifying a string address or string resource. For ToolTip text that exceeds 80 characters, see the Remarks section.

hinst

Handle to the instance that contains a string resource to be used as the ToolTip text. If lpszTextis a pointer to the ToolTip text string, hinstmust be NULL.

uFlags

Unsigned integer that specifies values that indicate how to interpret the idFrommember of the NMHDRstructure. The following table shows the possible values.

Value Description

TTF_IDISHWND

Indicates that the uIdmember is the window handle to the tool. If this flag is not set, uIdis the identifier of the tool.

TTF_RTLREADING

Displays the ToolTip text in the opposite direction to the text in the parent window.

TTF_DI_SETITEM

The ToolTip control retains the supplied information and does not request it again.
lParam

Application-defined data associated with the tool.

Remarks

You need to point the lpszTextmember to your own private buffer when the text that you want to use in the ToolTip exceeds 80 characters in length. The system automatically strips the ampersand (&) accelerator characters from all strings passed to a ToolTip control, unless the control has the TTS_NOPREFIX style.

Requirements

Header commctrl.h
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also