DeleteTableCellRingItems

int DeleteTableCellRingItems (int panel, int control, Point cell, int index, int numItems);

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 .

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer 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 NewCtrl or 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);

Example

DeleteTableCellRingItems (panelHandle, controlID, MakePoint (2, 3), 1, -1);

index integer The zero-based index of the first item to delete from the list of values.

numItems integer The number of items to delete.

To delete all items from Index to the end, enter –1.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success