AIT_SetCheck

Description

Turns on and off, and deactivates a specific control on the active window.

Format

bool AIT_SetCheck  (
 string strCaption,     // Control's caption
 integer nCtrlType      // Control type
 [,integer nCondition]  // Check type
 [,float fTimeOut]      // Time-out
);
bool AIT_SetCheck  (
 integer nCtrlID,       // Control ID
 integer nCtrlType      // Control type
 [,integer nCondition]  // Check status type
 [,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.

ValueDescription
CHECKBOX_CTRLThe control type is a check box.
OPTIONBUTTON_CTRLThe control type is an option button.

nCondition (input, optional)

Specify a check status type, which must be one of the following values.

ValueDescription
0Turned off
1Turned on
2Deactivated or grayed

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 numberError code
8ERROR_NOT_ENOUGH_MEMORY
14ERROR_OUTOFMEMORY
87ERROR_INVALID_PARAMETER
112ERROR_DISK_FULL
1400ERROR_INVALID_WINDOW_HANDLE
1460ERROR_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.