AIT_CtrlItemCount
- Organization of this page
Description
Uses a specific control in the active window to acquire the number of items.
Format
bool AIT_CtrlItemCount ( string strCaption, // Control's caption integer nCtrlType, // Control type integer nItemCount // Number of items [,float fTimeOut] // Time-out ); bool AIT_CtrlItemCount ( integer nCtrlID, // Control ID integer nCtrlType, // Control type integer nItemCount // Item count [,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.
Value |
Description |
---|---|
COMBO_CTRL |
The control type is a combo box. |
LISTBOX_CTRL |
The control type is a list box. |
TREE_CTRL |
The control type is a tree control. |
LIST_CTRL |
The control type is a list control. |
nItemCount (output)
Specify a variable for receiving the number of items in the control. When the control is returned from the function, the variable stores the number of items.
fTimeOut (input, optional)
Specify the maximum time the 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 number |
Error code |
---|---|
6 |
ERROR_INVALID_HANDLE |
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.