AIT_GetMenuIndex
- Organization of this page
Description
Acquires the index of a specified menu item.
Format
bool AIT_GetMenuIndex ( integer nMenu, // Menu handle string strMenuText, // Menu item integer nIndex // Index for a menu item [,float fTimeOut] // Time-out );
Parameters
nMenu (input)
Specify a menu handle.
strMenuText (input)
Specify a menu item.
nIndex (output)
Specify a variable to receive the index of a menu item. 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 |
---|---|
8 |
ERROR_NOT_ENOUGH_MEMORY |
14 |
ERROR_OUTOFMEMORY |
112 |
ERROR_DISK_FULL |
1401 |
ERROR_INVALID_MENU_HANDLE |
1460 |
ERROR_TIMEOUT |