Function Reference


_GUIToolTip_ToolToArray

Transfers a ToolInfo structure to an array

#include <GuiToolTip.au3>
_GUIToolTip_ToolToArray ( $hTool, ByRef $tToolInfo, $iError )

Parameters

$hTool Handle to the ToolTip control (returned by _GUIToolTip_Create.)
$tToolInfo $tagTOOLINFO structure
$iError Error code to be returned

Return Value

Returns an array with the following format:
    [0] - Flags that control the tooltip display. This member can be a combination of the following values:
        $TTF_IDISHWND = Indicates that $iID is the window handle to the tool instead of the ID
        $TTF_CENTERTIP = Centers the window below the tool specified by $iID
        $TTF_RTLREADING = Indicates that text will be displayed in the opposite direction
        $TTF_SUBCLASS = Indicates that the control should subclass the tool's window to intercept messages
        $TTF_TRACK = Positions the control next to the tool to which it corresponds
        $TTF_ABSOLUTE = Positions the window at the same coordinates provided by TTM_TRACKPOSITION
        $TTF_TRANSPARENT = Causes the control to forward mouse messages to the parent window
        $TTF_PARSELINKS = Indicates that links in the control text should be parsed
    [1] - Handle to the window that contains the tool
    [2] - Identifier of the tool
    [3] - X coordinate of the upper left corner of the rectangle
    [4] - Y coordinate of the upper left corner of the rectangle
    [5] - X coordinate of the lower right corner of the rectangle
    [6] - Y coordinate of the lower right corner of the rectangle
    [7] - Handle to the instance that contains the string resource for the tool
    [8] - Text for the tool
    [9] - Application-defined value associated with the tool

Remarks

$iError is the return code you want the function to return to the calling process.
This function is usually used with other UDF functions to disassemble the $tagTOOLINFO structure to an array for display purposes.
The Flags can be converted in a readable string with _GUIToolTip_BitsToTTF().

Related

_GUIToolTip_GetToolInfo, _GUIToolTip_BitsToTTF