CToolTipCtrl::AddTool

Registers a tool with the tool tip control.

BOOL AddTool( 
   CWnd* pWnd, 
   UINT nIDText, 
   LPCRECT lpRectTool = NULL, 
   UINT_PTR nIDTool = 0  
); 
BOOL AddTool( 
   CWnd* pWnd, 
   LPCTSTR lpszText = LPSTR_TEXTCALLBACK, 
   LPCRECT lpRectTool = NULL, 
   UINT_PTR nIDTool = 0  
);

Parameters

• pWnd
  Pointer to the window that contains the tool.

• nIDText
  ID of the string resource that contains the text for the tool.

• lpRectTool
  Pointer to a RECT structure containing coordinates of the tool's bounding rectangle. The coordinates are relative to the upper-left corner of the client area of the window identified by pWnd.

• nIDTool
  ID of the tool.

• lpszText
  Pointer to the text for the tool. If this parameter contains the value LPSTR_TEXTCALLBACK, TTN_NEEDTEXT notification messages go to the parent of the window that pWnd points to.

Return Value

Nonzero if successful; otherwise 0.

Remarks

The lpRectTool and nIDTool parameters must both be valid, or if lpRectTool is NULL, nIDTool must be 0.

A tool tip control can be associated with more than one tool. Call this function to register a tool with the tool tip control, so that the information stored in the tool tip is displayed when the cursor is on the tool.

Example

See the example for CPropertySheet::GetTabControl.

Requirements

Header: afxcmn.h

See Also

Reference

CToolTipCtrl Class

Hierarchy Chart

CToolTipCtrl::DelTool