AIT_VerifyFirstVisible

Description

Checks the index of the first visible item in a list box.

Format

integer AIT_VerifyFirstVisible  (
 string strCaption,     // Control's caption
 integer nCtrlType,     // Control type
 integer nIndex         // Index
);
integer AIT_VerifyFirstVisible  (
 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 LISTBOX_CTRL is valid.

nIndex (input)

Specify a control's index. As the index is based on 0, the index for the first item in a control is 0.

Return values

The return value is 1 if the specified index matches the index for the first visible item, 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
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.