TTM_ENUMTOOLS message

Retrieves the information that a tooltip control maintains about the current tool that is, the tool for which the tooltip is currently displaying text.

Parameters

wParam

Zero-based index of the tool for which to retrieve information.

lParam

Pointer to a TOOLINFO structure that receives information about the tool. Set the cbSize member of this structure to sizeof(TOOLINFO) before sending this message. Allocate a buffer. Set the lpszText member to point to the buffer to receive the tool text. There is no way to determine the required buffer size. However, tool text, as returned at the lpszText member of the TOOLINFO structure, has a maximum length of 80 TCHARs, including the terminating NULL. If the text exceeds this length, it is truncated.

Return value

Returns FALSE whether or not a tool was enumerated.

Remarks

Security Warning: Using this message might compromise the security of your program. This message does not provide a way for the message receiver to know the size of the buffer or to specify the size of the buffer. You should review the Security Considerations: Microsoft Windows Controls before continuing.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	Commctrl.h
Unicode and ANSI names	TTM_ENUMTOOLSW (Unicode) and TTM_ENUMTOOLSA (ANSI)