Admin Production ni-theme
Current Publication

SetTableCellValFromIndex

LabWindows/CVI

SetTableCellValFromIndex

int SetTableCellValFromIndex (int panelHandle, int controlID, Point cell, int index);

Purpose

Sets the value of a table control ring or combo-box cell to the specified item of the list of values of the cell.

Supported Controls

You can use SetTableCellValFromIndex 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 for which you want to set the 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);

Example

GetTableCellRingValueFromIndex (panelHandle, controlID, MakePoint (2, 3), 0, buffer);

index int The zero-based index into the list of values.

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