TTM_GETTOOLINFO message
Retrieves the information that a tooltip control maintains about a tool.
-
wParam
- Must be zero.
-
lParam
-
Pointer to a TOOLINFO structure. When sending the message, the hwnd and uId members identify a tool, and the cbSize member must specify the size of the structure. When using this message to retrieve the tooltip text, ensure that the lpszText member of the TOOLINFO structure points to a valid buffer of adquate size
Returns TRUE if successful, or FALSE otherwise.
If the tooltip control includes the tool, the TOOLINFO structure receives information about the tool.
The following example repositions a tooltip control.
HRESULT MyToolTipClass::OffsetTooltip(int xOffset, int yOffset)
{
HRESULT hr = S_OK;
DWORD dwError = 0;
if (NULL != m_hWndToolTip)
{
TOOLINFO ti = {0};
ti.cbSize = sizeof(TOOLINFO);
ti.hwnd = m_hWndToolTipOwner;
// Get the current tooltip definition.
if( SendMessage(m_hWndToolTip, TTM_GETTOOLINFO, 0, (LPARAM)&ti))
{
// Offset the tooltip rectangle as specified.
OffsetRect(&ti.rect, xOffset, yOffset);
// Apply the new rectangle to the tooltip.
SendMessage(m_hWndToolTip, TTM_NEWTOOLRECT, 0, (LPARAM)&ti);
}
else
{
dwError = GetLastError();
hr = HRESULT_FROM_WIN32(dwError);
MyErrorHandler(hr);
}
}
return hr;
}
Requirement | Value |
---|---|
Minimum supported client |
Windows Vista [desktop apps only] |
Minimum supported server |
Windows Server 2003 [desktop apps only] |
Header |
|
Unicode and ANSI names |
TTM_GETTOOLINFOW (Unicode) and TTM_GETTOOLINFOA (ANSI) |