AIT_CtrlItemIndex

Description

Uses a specific control in the active window to acquire the index of the item text.

Format

bool AIT_CtrlItemIndex  (
 string strCaption,     // Control's caption
 integer nCtrlType,     // Control type
 string strItemText,    // Item text
 integer nIndex         // Item index
 [,float fTimeOut]      // Time-out
);
bool AIT_CtrlItemIndex  (
 integer nCtrlID,       // Control ID
 integer nCtrlType,     // Control type
 string strItemText,    // Item text
 integer nIndex         // Item index
 [,float fTimeOut]      // Time-out
);

Parameters

strCaption (input)

Specify the caption of a control.

nCtrlID (input)

Specify a control ID.

nCtrlType (input)

Specify a control type, which must be one of the following values.

ValueDescription
COMBO_CTRLThe control type is a combo box.
LISTBOX_CTRLThe control type is a list box.
TREE_CTRLThe control type is a tree control.
LIST_CTRLThe control type is a list control.

strItemText (input)

Specify an item text for acquiring an index.

nIndex (output)

Specify a variable for receiving the text index. When the function returns, the variable stores the index for the item text. The default index value is 0.

fTimeOut (input, optional)

Specify the maximum time the function can use to find the control, in units of seconds. The default is the value set in the AIT_SetDefaultWaitTimeout function.

Return values

The return value is true if the function was executed normally, and false if not.

If the function has returned false, you can use AIT_GetLastError to acquire an extended error code. The following gives the error codes that AIT_GetLastError might return:

Extended error numberError code
6ERROR_INVALID_HANDLE
8ERROR_NOT_ENOUGH_MEMORY
14ERROR_OUTOFMEMORY
87ERROR_INVALID_PARAMETER
112ERROR_DISK_FULL
1400ERROR_INVALID_WINDOW_HANDLE
1413ERROR_INVALID_INDEX
1460ERROR_TIMEOUT

Note

You can identify the control by using a complete caption or an associated label name or specifying the first part of such a caption or label name. When specifying the first part, prefix a swung dash (~) to the character string that you specify.