AIT_VerifyIndex

Description

Checks whether the text matches the index in a specific control on the active window.

Format

integer AIT_VerifyIndex  (
 string strCaption,     // Control's caption
 integer nCtrlType,     // Control type
 string strCtrlText,    // Control text
 integer nIndex         // Index
);
integer AIT_VerifyIndex  (
 integer nCtrlID,       // Control ID
 integer nCtrlType,     // Control type
 string strCtrlText,    // Control text
 integer nIndex         // Index
);

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.

strCtrlText (input)

Specify the text of a control.

nIndex (input)

Specify a control's index based on 0.

Return values

The return value is 1 if the specified control's index matches the text, 0 if not, and -1 if the function has not been processed successfully. If -1 has been returned, 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
8ERROR_NOT_ENOUGH_MEMORY
14ERROR_OUTOFMEMORY
87ERROR_INVALID_PARAMETER
112ERROR_DISK_FULL
1400ERROR_INVALID_WINDOW_HANDLE
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.