Error and Return Codes
(Copy URL in PhpBB Forum Format - Info)From iMacros
iMacros displays an error message if it encounters an error and stops the current macro run (unless SET !ERRORIGNORE YES is used).
The general rule is:
- Success return code greater than 0 (Currently there is only one success code: 1)
- Failure return code less than 0
Notes:
- The code is sent via the Scripting Interface or command line interface. You can use this return code to find out whether a macro succeeded or not.
- With iimGetLastError() the text of an error message can be retrieved via the Scripting Interface.
- These error codes should not be confused with the Scripting Interface Return Codes which are between -1 and -100.
Contents |
User interaction
| Code | Reason |
|---|---|
| -101 | Aborted: User pressed the Stop button in the iMacros Browser. Typically, you can check this value to see if the user wants to exit the application. |
| -102 | Browser Closed: User pressed Exit button in the iMacros Browser, i.e. the iMacros Browser was closed by a user. |
Macro Playback
With version 7 we have started a new range of error codes between -1000 and -2000.
| Code | Reason |
|---|---|
| -1000 | Unspecified: Macro playback returned an error without explicitly specifying an error code. |
| -1010 | Not In Playback Mode: Error occurred while macro playback is not active (recording or idle mode). |
| -1100 | Load Failed: Failed to load the macro (syntax or I/O error) (Found wrong macro command while loading file). |
| -1110 | Invalid Macro Name: Invalid macro name specified for playback (Command Line Error: No Macro found). |
| -1200 | Bad Parameter: Invalid macro parameter was specified. |
| -1210 | Cannot Compile Regex: Cannot compile regular expression (as in SEARCH). |
| -1220 | Wrong Decryption Password: Incorrect decryption password supplied. Please enter the correct password in the OPTIONS dialog or re-run the macro. |
| -1230 | File Not Found: Filename specified in the macro command (e.g. IMAGESEARCH) doesn't exist. |
| -1240 | Invalid Record Index: The data source record with requested index does not exist. |
| -1300 | Html Element Not Found: Cannot find HTML element. |
| -1310 | Non Expected Tag Found: HTML element was found when EVENT:FAIL_IF_FOUND was specified. |
| -1320 | Search Query Not Found: Search query not found in source. |
| -1400 | Dialog Manager Error: Indicates that an exception has occurred in Dialog Manager. |
| -1410 | No Download Detected: Macro contains ONDOWNLOAD, but no download dialog was detected. |
| -1420 | Checksum Not Verified: Checksum of downloaded file does not match specified. |
| -1500 | Unsupported Version: This macro was created with an older version of iMacros. Or the feature is not licensed in this product. |
| -1600 | Invalid Stopwatch Id: Invalid Stopwatch ID or LABEL specified, duplicate or nonexistent. |
| -1610 | Stopwatch Already Running: Stopwatch with this ID or label is already running. |
| -1620 | Stopwatch Not Started: Cannot stop stopwatch before it's started. |
| -1700 | Invalid Select Content: Selected entry in a select box is not available. |
| -1710 | Invalid Check Radio Content: Invalid CONTENT parameter specified for check or radio box. |
| -1800 | Image Not Found: Could not find image with given confidence in browser screen. |
| -1810 | Image Recognition Internal Error: Internal Error in Image Recognition Plugin (Is it properly installed?). |
| -1820 | Cannot Load Image: Image file could not be loaded. |
| -1900 | Document Null: Failed to run a command because no page has been opened in the web browser or could not retrieve the page source (document is null). |
| -1910 | Invalid Target Window: Cannot locate target web browser window or frame. |
| -2000 | Set Proxy Error: Unable to set proxy server settings. |
Firefox Error Codes
Errors specific for the Firefox Add-on.
| Code | Reason |
|---|---|
| -808 | Unrecognized command (e. g. DS) |
| -926 | SEARCH text or expression was not found |
Scripting Interface Return Codes
After each command the Scripting Interface returns a code. You can use this return code to find out whether a command succeeded or not. The general rule is:
- Success return code greater equal 0
- Failure return code less than 0
- You can use iimGetLastError() to retrieve the text associated with the last error.
- 1 (sOk)
- Macro completed Ok
- -1 (sFail)
- Scripting Interface can not complete this command. Typically this error can occur if the software is not installed correctly
- -2 (sNotCompleted)
- A command was started but did not complete. This error happens only if the browser is terminated so abruptly that iMacros can not respond back to the interface. Typically this happens only in the rare case of a browser crash. If the user simply closes the browser you will get the -102 error instead (see below).
- -3 (sTimeout)
- The iMacros browser did not respond in a certain time. The default timeout is 600s. You can change this value individually for some commands. For example, you can specify iimPlay(<macro>, <timeout>). In addition to a normal timeout, this error also occurs if the browser freezes for any reason. (In the trial version this error can also occur if you do not press the iMacros trial version reminder screen "Continue" button in time. This issue can never occur in the full version.)
- -4 (sNotStarted)
- Could not start the iMacros browser. Typically this indicates an installation issue.
- -6
- iimRunner error message, see iimInit return values for details
- -7
- iimRunner error message, see iimInit return values for details
- -20
- This error occurs if you start iimInit() twice.
- -100...-2000 (sMacroError)
- sMacroError can have a value of -100 and lower (-101,-102,...,-2000). These are NOT Scripting Interface error codes, but errors created by the iMacros browser and the macro itself. The Scripting Interface passes them from the browser to your script or application.
- -101
- User pressed Stop button in the iMacros Browser. Typically, you can check on this value to see if the user wants to exit the application.
- -102
- User pressed Exit button in the iMacros Browser, i.e. the iMacros Browser was closed by a user. Note that this is not the same as sNotComplete. The code "sNotComplete"(-2) indicates that he browser was closed e.g. by the task scheduler or a crash and not by a regular user exit or stop.
- -200...-600
- Error codes generated by iMacros version 6 and older during the macro replay.
- -800...-999
- iMacros for Firefox macro replay error codes.
- -1000...-2000
- Playback errors generated by iMacros 7. These are the same errors (or error codes) that you get during a manual macro replay (if you start the macro by clicking the "Play" button). For more information on these errors please see the List of iMacros Browser Error Codes.
