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

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

AIT_CtrlClick

Description

Simulates a mouse click on a specific control in the active window.

Format

bool AIT_CtrlClick  (
  string strCaption,     // Control's caption
  integer nCtrlType,     // Control type
  integer nMouseButton   // Mouse button
  [,float fTimeOut]      // Time-out
);
bool AIT_CtrlClick  (
  integer nCtrlID,       // Control ID
  integer nCtrlType,     // Control type
  integer nMouseButton   // Mouse button
  [,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
BUTTON_CTRL The control type is a command button.
CHECKBOX_CTRL The control type is a check box.
OPTIONBUTTON_CTRL The control type is an option button.
EDIT_CTRL The control type is an edit box.
STATIC_CTRL The control type is a static text control.
COMBO_CTRL The control type is a combo box.
LISTBOX_CTRL The control type is a list box.
SPIN_CTRL The control type is a spin control.
TREE_CTRL The control type is a tree control.
LIST_CTRL The control type is a list control.
DTPICKER_CTRL The control type is a date/time picker.

nMouseButton (input, optional)

Specify the mouse button for which a click operation should be simulated. You have to set one of the following values.

Value Description
LBUTTON Left mouse button
MBUTTON Center mouse button
RBUTTON Right mouse button

The default is LBUTTON.

fTimeOut (input, optional)

Specify the maximum time the function can use to find a 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
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.