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

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

AIT_SelectListItem

Description

Selects an item specified in a specific control on the active window.

Format

bool AIT_SelectListItem  (
  string strCaption,    // Control's caption
  integer nCtrlType,    // Control type
  string strItemText    // Item text selected
  [,float fTimeOut]     // Time-out
);
bool AIT_SelectListItem  (
  integer nCtrlID,      // Control ID
  integer nCtrlType,    // Control type
  string strItemText    // Item text selected
  [,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.

Value Description
COMBO_CTRL The control type is a combo box.
LISTBOX_CTRL The control type is a list box.
LIST_CTRL The control type is a list control.

strItemText (input)

Specify text you want to select on a specific control.

fTimeOut (input, optional)

Specify the maximum time this 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 may return.

Extended error number Error code
6 ERROR_INVALID_HANDLE
8 ERROR_NOT_ENOUGH_MEMORY
14 ERROR_OUTOFMEMORY
87 ERROR_INVALID_PARAMETER
112 ERROR_DISK_FULL
1400 ERROR_INVALID_WINDOW_HANDLE
1460 ERROR_TIMEOUT

Notes

You must not use the AIT_SelectListItem function for multiple controls that can be selected.

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.