GetPanelAttribute
int GetPanelAttribute (int panelHandle, int panelAttribute, void *attributeValue);
Purpose
Returns the value of a specific panel attribute.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| panelAttribute | int | The panel 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 is shown for each attribute. Select an attribute by double-clicking it or by selecting it and then pressing <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>. If there is a value shown in the bottom half of the Attribute Value control, the corresponding named constant is marked in the displayed list. |
| Output | ||
| Name | Type | Description |
| attributeValue | void * | Current value of the panel attribute. The data type for this parameter depends on the data type of the attribute you specify for the panelAttribute parameter. Pass the address of a variable of the same data type of the attribute you pass to panelAttribute. 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. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later
Examples
Refer to the following examples that use the GetPanelAttribute function:
- apps\uirview\uirview.cws
Open example - userint\tabpanels.cws
Open example