InsertTableCellRangeRingItem
int InsertTableCellRangeRingItem (int panelHandle, int controlID, Rect cellRange, int index, char value[]);
Purpose
Inserts a new item into the list of values of a specified range of ring or combo-box cells of a table control.
The indexes of existing values at and beyond the specified index are increased by one.
Supported Controls
You can use InsertTableCellRangeRingItem 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. |
| cellRange | Rect | A Rect structure specifying the range of cells into which you want to insert the new value. The cells in the specified range must be of type VAL_CELL_RING, or VAL_CELL_COMBO_BOX, or a mixture of the two. If the range includes cells of any other type, an error is returned and the results are unspecified. The Rect structure is defined as follows: typedef struct { int top; int left; int height; int width; } Rect; Pass the one-based row and column indices of the first cell in the range as the top and left fields of the structure, respectively. Pass the number of columns in the range as the width field of the structure, and the number of rows in the range as the height field of the structure. You can create a Rect without having to declare a variable by using the following function: Rect MakeRect (int top, int left, int height, int width); ExampleInsertTableCellRangeRingItem (panelHandle, controlID, MakeRect (2, 3, 5, 5), -1, "new value"); |
| index | int | The zero-based index into the value list of the cells where the new item is placed. Pass –1 to insert the new item at the end of the value list. This index must be valid for every cell in the specified range. If it is not valid for one or more cells, an error is returned and the results are unspecified. |
| 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 InsertTableCellRangeRingItem function.