Job Management Partner 1/Software Distribution Automatic Installation Tool Description and Reference

[Contents][Glossary][Index][Back][Next]

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.

Value Description
COMBO_CTRL The control type is a combo box.
LISTBOX_CTRL The control type is a list box.
TREE_CTRL The control type is a tree control.
LIST_CTRL The 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 may return.

Extended error number Error code
8 ERROR_NOT_ENOUGH_MEMORY
14 ERROR_OUTOFMEMORY
87 ERROR_INVALID_PARAMETER
112 ERROR_DISK_FULL
1400 ERROR_INVALID_WINDOW_HANDLE
1460 ERROR_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.