AIT_GetEditFirstLineIndex
- Organization of this page
Description
Acquires the index of the first line in the edit box containing multiple lines, or for the first character in the edit box containing a single line.
Format
bool AIT_GetEditFirstLineIndex ( string strCaption, // Control's caption integer nFirstVisible // Index for the first line or character [,float fTimeOut] // Time-out ); bool AIT_GetEditFirstLineIndex ( integer nCtrlID, // Control ID integer nFirstVisible // Index for the first line or character [,float fTimeOut] // Time-out );
Parameters
strCaption (input)
Specify the caption of a control.
nCtrlID (input)
Specify a control ID.
nFirstVisible (output)
Specify the variable for receiving the index value for the first line or character. When the function returns, the variable stores the index. The default index value is 0.
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 |
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.