EasyTab_GetAttribute

int EasyTab_GetAttribute (int panel, int tabControl, int attribute, void *attributeValue);

Purpose

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 integer 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 integer The ID returned by the EasyTab_Create or EasyTab_ConvertFromCanvas function.
attribute integer 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 integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

The possible negative error codes are:

Return Values: 0   Success
–1 to –999 A User Interface Library error code. (Constants are available in userint.h.)
–5000 to –5499 A Toolbox instrument driver error code. (Constants are available in toolbox.h.)

A description of any of these error codes can be obtained using the GetGeneralErrorString function in the toolbox.fp instrument driver.