Share via


CToolTipCtrl::GetToolInfo

Retrieves the information that a tool tip control maintains about a tool.

BOOL GetToolInfo( 
   CToolInfo& ToolInfo, 
   CWnd* pWnd, 
   UINT_PTR nIDTool = 0 
) const;

Parameters

  • ToolInfo
    Reference to a TOOLINFO object that receives the tool's text.

  • pWnd
    Pointer to the window that contains the tool.

  • nIDTool
    ID of the tool.

Return Value

Nonzero if successful; otherwise 0.

Remarks

The hwnd and uId members of the TOOLINFO structure referenced by CToolInfo identify the tool. If that tool has been registered with the tool tip control through a previous call to AddTool, the TOOLINFO structure is filled with information about the tool.

Requirements

Header: afxcmn.h

See Also

Reference

CToolTipCtrl Class

Hierarchy Chart

CToolTipCtrl::AddTool

Other Resources

CToolTipCtrl Members