AIT_GetCtrlText
- Organization of this page
Description
Acquires text from a specific control in the active window.
Format
bool AIT_GetCtrlText ( string strCaption, // Control's caption integer nCtrlType, // Control type string strCtrlText // Control's text [,float fTimeOut] // Time-out ); bool AIT_GetCtrlText ( integer nCtrlID, // Control ID integer nCtrlType, // Control type string strCtrlText // Control's text [,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 |
---|---|
BUTTON_CTRL |
The control type is a command button. |
CHECKBOX_CTRL |
The control type is a check box. |
OPTIONBUTTON_CTRL |
The control type is an option button. |
EDIT_CTRL |
The control type is an edit box. |
STATIC_CTRL |
The control type is a static text control. |
COMBO_CTRL |
The control type is a combo box. |
LISTBOX_CTRL |
The control type is a list box. |
SPIN_CTRL |
The control type is a spin control. |
TREE_CTRL |
The control type is a tree control. |
LIST_CTRL |
The control type is a list control. |
DTPICKER_CTRL |
The control type is a date/time picker. |
strCtrlText (output)
Specify a variable to receive the text of a control. When the function returns, the variable stores text.
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 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 |
Notes
-
For an edit box, the function acquires a text for its contents. For a static text and button, it acquires a control's caption. For the other controls, it acquires the currently selected item as the text.
-
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.