AIT_VerifyLine

Description

Verifies on the active window that the index matches the current line on an edit box containing multiple lines.

Format

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

Parameters

strCaption (input)

Specify the caption of a control.

nCtrlID (input)

Specify a control ID.

nCtrlType (input)

Specify a control type for which only EDIT_CTRL is valid.

nIndex (input)

Specify the index of the current line to be checked. As the index value is based on 0, the index for the first line in an edit box is 0.

Return values

The return value is 1 if the current line in an edit box matches a specified index, 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 might return:

Extended error numberError code
6ERROR_INVALID_HANDLE
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.