GetCtrlArrayIndex
int GetCtrlArrayIndex (int controlArrayHandle, int panelHandle, int controlID, int *index);
Purpose
Returns the zero-based index of the specified control in the control array.
This function returns the index –1 if the control is not found.
Supported Controls
You can use GetCtrlArrayIndex with all LabWindows/CVI user interface controls.
Parameters
| Input | ||
| Name | Type | Description |
| controlArrayHandle | int | Specifier for a particular control array that is currently in memory. You obtain this handle from GetCtrlArrayFromResourceID or NewCtrlArray. |
| 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. |
| Output | ||
| Name | Type | Description |
| index | int | The zero based index of the specified control in the control array. |
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 2010 and later