GetTableCellRingItemAttribute
int GetTableCellRingItemAttribute (int panelHandle, int controlID, Point cell, int index, int itemAttribute, void *attributeValue);
Purpose
Obtains the value of a ring item attribute. Use this function to interact with table cells whose type is ring or combo box.
Supported Controls
You can use GetTableCellRingItemAttribute with table controls.
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. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| cell | Point | A Point structure specifying the cell that contains the ring item. The specified cell must be of type VAL_CELL_RING or VAL_CELL_COMBO_BOX. The Point structure is defined as follows: typedef struct { int x; int y; } Point; Pass the one-based column index of the cell in the x field of the structure, and the one-based row index of the cell in the y field of the structure. You can create a Point without having to declare a variable by using the following function: Point MakePoint (int x, int y); ExampleGetTableCellRingAttribute (panelHandle, controlID, MakePoint (2, 3), 0, ATTR_BOLD, &isBold); |
| index | int | The zero-based index into the list of values. |
| itemAttribute | int | The ring item attribute value to get. 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 ring item attribute. The data type for this parameter depends on the data type of the attribute you specify for the itemAttribute parameter. Pass the address of a variable of the same data type of the attribute you pass to itemAttribute. If the attribute shown in this ring 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 2012 and later