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

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

AIT_VerifyLocation

Description

Checks whether a specific control in the active window matches specified coordinates.

Format

integer AIT_VerifyLocation  (
  string  strCaption,   // Control's caption
  integer nCtrlType,    // Control type
  integer nLeft,        // Coordinates of the top left control corner
  integer nTop,         // Coordinates of the control top
  integer nRight,       // Coordinates of the top right control corner
  integer nBottom       // Coordinates of the control bottom
);
integer AIT_VerifyLocation  (
  integer nCtrlID,      // Control ID
  integer nCtrlType,    // Control type
  integer nLeft,        // Coordinates of the top left control corner
  integer nTop,         // Coordinates of the control top
  integer nRight,       // Coordinates of the top right control corner
  integer nBottom       // Coordinates of the control bottom
);

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

nLeft (input)

Specify the X coordinate of the top left control corner.

nTop (input)

Specify the Y coordinate of the top left control corner.

nRight (input)

Specify the X coordinate of the bottom right control corner.

nBottom (input)

Specify the Y coordinate of the bottom right control corner.

Return values

The return value is 1 if coordinates of a control match specified ones, 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.