CTooltip.EnumToolsmethod
Retrieves the information that a Tooltip control maintains about the current tool--that is, the tool for which the Tooltip is currently displaying text.
Syntax
FUNCTION EnumTools (BYVAL hTooltip AS HWND, BYVAL iTool AS DWORD, BYVAL lpti AS TOOLINFOW PTR) AS BOOLEAN
FUNCTION EnumTools (BYVAL hTooltip AS HWND, BYVAL iTool AS DWORD, BYREF ti AS TOOLINFOW) AS BOOLEAN
Parameters
| Name | Description | |
|---|---|---|
hTooltip | The handle of the Tooltip control. | |
iTool | Zero-based index of the tool for which to retrieve information. | |
lpti | Pointer to a TOOLINFOW structure that receives information about the tool. Set the cbSize member of this structure to sizeof(TOOLINFOW) 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 TOOLINFOW 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.
Description
Retrieves the information that a Tooltip control maintains about the current tool--that is, the tool for which the Tooltip is currently displaying text.
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.
Reference
- Include file
CTooltip.inc - Defined in AfxNova/CTooltip.inc:222
- Documented in Windows/WIndows Controls/CTooltip Class.md
- Topic: CTooltip Class