GetCtrlToolTipAttribute
- Updated2023-02-21
- 2 minute(s) read
GetCtrlToolTipAttribute
int GetCtrlToolTipAttribute (int panelHandle, int controlId, int toolTipAttribute, void *attributeValue);
Purpose
 |
Note This function has been superseded by the ATTR_TOOLTIP_TEXT and ATTR_TOOLTIP_LENGTH attributes. |
This function gets tooltip attributes for the control you specify.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | The specifier for a particular panel that is currently in memory. You obtain the handle by calling the LoadPanel, NewPanel, or DuplicatePanel function. |
| controlId | int | The defined constant (located in the UIR header file) that you assign to the control in the User Interface Editor, or the ID that you obtain by calling the NewCtrl or DuplicateCtrl function. |
| toolTipAttribute | int | The tooltip attribute value to obtain. In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a hierarchical list of the available attributes. Attributes whose values cannot be obtained are dimmed. Help text is shown for each attribute. To select an attribute, double-click it or select it and then press <Enter>. If the attribute shown in this ring control has named constants as valid values, you can open a list of them by moving to the Attribute Value control and pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
| attributeValue | void * | The value of the specified tooltip attribute. If the attribute shown in this control has named constants as valid values, you can open a list of them by pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
Return Value
| Name | Type | Description |
| status | int | Returns a negative error code if an error occurs. |
Additional Information
Library: Programmer's Toolbox
Include file: toolbox\toolbox.h
LabWindows/CVI compatibility: LabWindows/CVI 7.0 and later