Admin Production ni-theme
Current Publication

SetActiveTableCell

LabWindows/CVI

SetActiveTableCell

int SetActiveTableCell (int panelHandle, int controlID, Point cell);

Purpose

Sets the active cell of the specified table control.

Setting the active cell causes the table control to lose the current selection.

Supported Controls

You can use SetActiveTableCell 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 new active cell.

The Point structure is defined as follows:

typedef struct
   {
   int x;
   int y;
   } Point;


Pass the one-based column index of the new active cell in the x field of the structure, and the one-based row index of the new active 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

SetActiveTableCell (panelHandle, controlID, MakePoint (2, 3));

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 5.5 and later