Admin Production ni-theme
Current Publication

SetCtrlIndex

LabWindows/CVI

SetCtrlIndex

int SetCtrlIndex (int panelHandle, int controlID, int itemIndex);

Purpose

Sets the current index of a list. This action moves the selection in the list to the item located at the index you specify.

Supported Controls

You can use SetCtrlIndex with the following 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.
itemIndex int Zero-based index into the list control.

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

Examples

Refer to the following examples that use the SetCtrlIndex function:

  • userint\imagedit.cws

    Open example
  • userint\listdelx.cws

    Open example