AIT_VerifyState

Description

Checks whether the specific control has been checked in the active window.

To Page Top

Format

integer AIT_VerifyState  (
  string strCaption,    // Control's caption
  integer nCtrlType     // Control type
);
integer AIT_VerifyState  (
  integer nCtrlID,      // Control ID
  integer nCtrlType     // Control type
);

To Page Top

Parameters

To Page Top

Return values

The return value is 1 if the control is checked, 0 if not, 2 if unknown, and -1 if the function has not been processed successfully. The unknown status is applied only to CHECKBOX_CTRL. 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 might return:

To Page Top

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.

To Page Top