AIT_GetMenuText

Description

Acquires a specified menu item.

Format

bool AIT_GetMenuText  (
 integer nMenu,        // Menu handle
 integer nIndex,       // Index for a menu item
 string strMenuText    // Menu item
 [,float fTimeOut]     // Time-out
);

Parameters

nMenu (input)

Specify a menu handle.

nIndex (input)

Specify the index of a menu item. The default index value is 0.

strMenuText (output)

Specify a variable to receive a menu item. When the function returns, the variable stores the menu item.

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 numberError code
8ERROR_NOT_ENOUGH_MEMORY
14ERROR_OUTOFMEMORY
87ERROR_INVALID_PARAMETER
112ERROR_DISK_FULL
1401ERROR_INVALID_MENU_HANDLE
1460ERROR_TIMEOUT