GetTableCellAttribute
int GetTableCellAttribute (int panelHandle, int controlID, Point cell, int cellAttribute, void *attributeValue);
Purpose
Obtains an attribute of a table cell.
Supported Controls
You can use GetTableCellAttribute 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 from which the function obtains the attribute. 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); ExampleGetTableCellAttribute (panelHandle, controlID, MakePoint (2, 3), cellAttribute, &attributeValue); |
| cellAttribute | int | The cell 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 cell attribute. The data type for this parameter depends on the data type of the attribute you specify for the cellAttribute parameter. Pass the address of a variable of the same data type of the attribute you pass to cellAttribute. 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 5.5 and later
Example
Refer to userint\gridview.cws for an example of using the GetTableCellAttribute function.