GetTableCellVal
int GetTableCellVal (int panelHandle, int controlID, Point cell, void *value);
Purpose
Obtains the current value of a table control cell.
Supported Controls
You can use GetTableCellVal 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 you want to obtain the value. 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); ExampleGetTableCellVal (panelHandle, controlID, MakePoint (2, 3), &value); |
| Output | ||
| Name | Type | Description |
| value | void * | The cell value. The value that this function returns depends on the cell type of the specified cell. If the cell type is VAL_CELL_PICTURE, the function returns the bitmap stored in the cell, or zero if there is no bitmap. When you no longer need the bitmap, free it using DiscardBitmap. If the cell type is VAL_CELL_STRING, VAL_CELL_RING, VAL_CELL_COMBO_BOX, or VAL_CELL_BUTTON, the function expects you to pass a buffer large enough to hold the corresponding string, plus the terminating NUL. Use GetTableCellValLength to obtain the length of the string. If the cell type is VAL_CELL_NUMERIC, the function expects the data type of value to match the data type of the cell. |
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
Examples
Refer to the following examples that use the GetTableCellVal function:
- userint\colview.cws
Open example - userint\gridview.cws
Open example