GetTableCellRingIndexFromValue
int GetTableCellRingIndexFromValue (int panelHandle, int controlID, int beginningIndex, Point cell, int *index, char value[]);
Purpose
Searches the list of values of a specified ring or combo-box cell of a table control and returns the index of the first item in the list with a value matching the specified value.
This function returns the index –1 if the value is not found.
Supported Controls
You can use GetTableCellRingIndexFromValue 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. |
| beginningIndex | int | The zero-based index specifying the first item the function searches. |
| cell | Point | A Point structure specifying the cell which you want to search. 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); ExampleGetTableCellRingIndexFromValue (panelHandle, controlID, 0, MakePoint (2, 3), &item, "abc"); |
| value | char [] | The value you want to locate in the list. The ATTR_CASE_SENSITIVE_COMPARE attribute determines whether or not the comparison is case-sensitive. |
| Output | ||
| Name | Type | Description |
| index | int | The zero-based index of the first item matching the specified value. |
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 8.0 and later