InsertTableCellRingItem
int InsertTableCellRingItem (int panelHandle, int controlID, Point cell, int index, char value[]);
Purpose
Inserts a new item into the list of values of a specified ring or combo-box cell of a table control.
The indexes of existing values at and beyond the specified index are increased by one.
Supported Controls
You can use InsertTableCellRingItem 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 into which you want to insert the new value. 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); ExampleInsertTableCellRingItem (panelHandle, controlID, MakePoint (2, 3), -1, "new value"); |
| index | int | The zero-based index into the value list of the cell where the new item is placed. Pass –1 to insert the new item at the end of the value list. |
| value | char [] | The new value to insert in the value list. If ATTR_RING_ITEMS_UNIQUE is enabled and this value matches an existing value in the list, then a new item will not be added to the list. |
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
Example
Refer to userint\tablecells.cws for an example of using the InsertTableCellRingItem function.