Hitachi

JP1 Version 12 JP1/IT Desktop Management 2 Distribution Function Administration Guide


AIT_SelectMultipleListItem

Organization of this page

Description

Selects the specified items in a specific multi-selection control on the active window.

Format

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

LISTBOX_CTRL

The control type is a list box.

LIST_CTRL

The control is a list control.

strItemText (input)

Specify the text items you want to select in the multi-selection control. You can specify multiple values delimited by a comma.

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 might 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

Use the AIT_SelectMultipleListItem function only for controls that allow selection of multiple values.

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.