EasyTab_GetAttribute
- Updated2023-02-21
- 2 minute(s) read
int EasyTab_GetAttribute (int panel, int tabControl, int attribute, void *attributeValue);
Purpose
 |
Note This function is deprecated. National Instruments recommends that you use the tab control instead. |
Obtains the value of an attribute of the selected Tab control.
Because attributes may take values of different data types with different valid ranges, a list of attributes, their data types and valid values are provided in the help for attributeValue.
Parameters
| Input | ||
| Name | Type | Description |
| panel | int | The specifier for a particular panel that is currently in memory. This handle will have been returned by the LoadPanel, NewPanel, or DuplicatePanel function. |
| tabControl | int | The ID returned by the EasyTab_Create or EasyTab_ConvertFromCanvas function. |
| attribute | int | The easy tab 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. |
| Output | ||
| Name | Type | Description |
| attributeValue | void * | The value of the specified easy tab 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 | Return value indicating whether the function was successful. A negative number indicates that an error occurred. The possible negative error codes are:
A description of any of these error codes can be obtained using the GetGeneralErrorString function in the toolbox.fp instrument driver. |
Additional Information
Library: Easy Tab Control
Include file: custctrl\easytab.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later