GetCtrlIndex

int GetCtrlIndex (int panelHandle, int controlID, int *itemIndex);

Purpose

Returns the zero-based index of the currently selected item in a list box, ring, or tree control.

To obtain the value of the currently selected item, call GetCtrlVal.

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.
Output
Name Type Description
itemIndex integer The zero-based current index of the currently selected item.

—1 if the list control has no items.

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