DeleteTableCellRingItems
int DeleteTableCellRingItems (int panelHandle, int controlID, Point cell, int index, int numberOfItems);
Purpose
Deletes one or more items from the list of values of a specified ring or combo-box cell of a table control.
The indexes of the remaining values beyond the specified index are decreased by numItems .
Supported Controls
You can use DeleteTableCellRingItems 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 remove the values. 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); ExampleDeleteTableCellRingItems (panelHandle, controlID, MakePoint (2, 3), 1, -1); |
| index | int | The zero-based index of the first item to delete from the list of values. |
| numberOfItems | int | The number of items to delete. To delete all items from Index to the end, enter –1. |
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