DeleteTableCellRangeRingItems
int DeleteTableCellRangeRingItems (int panelHandle, int controlID, Rect cellRange, int index, int numberOfItems);
Purpose
Deletes one or more items from the list of values of a specified range of ring or combo-box cells of a table control.
The indexes of the remaining values beyond the specified index are decreased by numItems .
Supported Controls
You can use DeleteTableCellRangeRingItems 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 from which you want to remove the values. 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); ExampleDeleteTableCellRangeRingItems (panelHandle, controlID, MakeRect (2, 3, 5, 5), 1, -1); |
| index | int | The zero-based index of the first item to delete from the list of values 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. |
| 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