The renewal maintenance has officially ended for Progress iMacros effective November 30, 2023.
This Wiki site will also no longer be moderated from the Progress side.
Thank you again for your business and support.
Sincerely, The Progress Team
Difference between revisions of "Command Reference"
(44 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
− | A high-level overview on the different versions of iMacros can be found [ | + | A high-level overview on the different versions of iMacros can be found [https://imacros.net/store/compare-versions/ here] |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
The browser icons [[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]] listed below and on each command detail page denote browser compatibility. Commands that are supported in all browsers work exactly the same in each browser, so macros created in the iMacros Browser (or Internet Explorer) can be replayed in iMacros for Firefox and vice versa. Browser specific differences are automatically handled by iMacros. | The browser icons [[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]] listed below and on each command detail page denote browser compatibility. Commands that are supported in all browsers work exactly the same in each browser, so macros created in the iMacros Browser (or Internet Explorer) can be replayed in iMacros for Firefox and vice versa. Browser specific differences are automatically handled by iMacros. | ||
− | ==iMacros Commands Reference == | + | == iMacros Commands Reference == |
{| | {| | ||
Line 24: | Line 15: | ||
|- | |- | ||
|[[Image:Ff-icon.png|Firefox]]||[[CLICK]] | |[[Image:Ff-icon.png|Firefox]]||[[CLICK]] | ||
+ | |- | ||
+ | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[DISPLAY]] | ||
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[DS]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[DS]] | ||
Line 29: | Line 22: | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[EVAL]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[EVAL]] | ||
|- | |- | ||
− | | ||[[EXTRACT]] (Part of the [[TAG]] command | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[EVENT]] |
+ | |- | ||
+ | | ||[[EXTRACT]] (Part of the [[TAG]] command) | ||
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]]||[[FILEDELETE]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]]||[[FILEDELETE]] | ||
Line 45: | Line 40: | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]]||[[ONDIALOG]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]]||[[ONDIALOG]] | ||
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]]||[[ONDOWNLOAD]] | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[ONDOWNLOAD]] |
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[ONERRORDIALOG]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[ONERRORDIALOG]] | ||
Line 71: | Line 66: | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[SAVEAS]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[SAVEAS]] | ||
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]]||[[SAVEITEM]] | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[SAVEITEM]] |
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[SCREENSHOT]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[SCREENSHOT]] | ||
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]]||[[SEARCH]] | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[SEARCH]] |
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[set|SET]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[set|SET]] | ||
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[SIZE]] | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[SIZE]] |
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[STOPWATCH]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[STOPWATCH]] | ||
Line 87: | Line 82: | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[TAG]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[TAG]] | ||
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]]||[[TRAY]] | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[TRAY]] |
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[URL]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[URL]] | ||
Line 112: | Line 107: | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!DATASOURCE_COLUMNS]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!DATASOURCE_COLUMNS]] | ||
|- | |- | ||
− | |[[Image:Ff-icon.png|Firefox]]||[[!DATASOURCE_DELIMITER]] | + | |[[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!DATASOURCE_DELIMITER]] |
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!DATASOURCE_LINE]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!DATASOURCE_LINE]] | ||
Line 140: | Line 135: | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!FILE_PROFILER]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!FILE_PROFILER]] | ||
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] ||[[!FOLDER_DATASOURCE]] | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!FOLDER_DATASOURCE]] |
+ | |- | ||
+ | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]] ||[[!FOLDER_DOWNLOAD]] | ||
+ | |- | ||
+ | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] ||[[!FOLDER_LOG]] | ||
+ | |- | ||
+ | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]] ||[[!FOLDER_MACROS]] | ||
+ | |- | ||
+ | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!FOLDER_STOPWATCH]] | ||
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] ||[[!HTTP_ERRORCODE]] Version 11.5 and above |
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[!IMAGEX]] | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!IMAGEX]] |
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[!IMAGEY]] | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!IMAGEY]] |
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!LOOP]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!LOOP]] | ||
Line 153: | Line 156: | ||
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!NOW]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!NOW]] | ||
+ | |- | ||
+ | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!PLAYBACKDELAY]] | ||
|- | |- | ||
|[[Image:Ff-icon.png|Firefox]]||[[!POPUP_ALLOWED]] | |[[Image:Ff-icon.png|Firefox]]||[[!POPUP_ALLOWED]] | ||
Line 192: | Line 197: | ||
|[[Image:IMacros-icon.png|iMacros Browser]] ||[[!USE_DOWNLOADMANAGER]] Version 10.3 and above | |[[Image:IMacros-icon.png|iMacros Browser]] ||[[!USE_DOWNLOADMANAGER]] Version 10.3 and above | ||
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image: | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!USERAGENT]] |
|- | |- | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!VAR0...!VAR9]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]]||[[!VAR0...!VAR9]] | ||
Line 198: | Line 203: | ||
|[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[!WAITPAGECOMPLETE]] | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[!WAITPAGECOMPLETE]] | ||
|- | |- | ||
− | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[!X_PERFLOG_NOTARGETPATH]] | + | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[!WINDOW_TITLE]] Version 11.5 and above |
+ | |- | ||
+ | |[[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]||[[!X_PERFLOG_NOTARGETPATH]] Version 10.3 and above | ||
|} | |} | ||
Line 205: | Line 212: | ||
User-defined variables are created with the [[set|SET]] and [[iimSet]] commands. Use [[iimSet]] to pass variables from [[Web Scripting|script code]] to a macro. See also this [[Variables|iMacros variable types overview]]. | User-defined variables are created with the [[set|SET]] and [[iimSet]] commands. Use [[iimSet]] to pass variables from [[Web Scripting|script code]] to a macro. See also this [[Variables|iMacros variable types overview]]. | ||
− | ==Scripting Interface Command Overview== | + | ==Scripting Interface Command Overview [[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]] == |
− | The Scripting Interface | + | The Scripting Interface works with the iMacros Browser, Internet Explorer, Firefox and Chrome (see [[iimOpen]] for details on how to switch between the browsers). |
#[[iimOpen]] (old: [[iimInit()]]) | #[[iimOpen]] (old: [[iimInit()]]) | ||
+ | #[[iimGetBrowserPid]] (iMacros 10.4) | ||
#[[iimDisplay]] | #[[iimDisplay]] | ||
#[[iimGetInterfaceVersion()]] | #[[iimGetInterfaceVersion()]] | ||
Line 214: | Line 222: | ||
#[[iimPlay]] and [[iimPlayCode]]() | #[[iimPlay]] and [[iimPlayCode]]() | ||
#[[iimSet]] | #[[iimSet]] | ||
+ | #[[iimSetWindowTitle]]() (iMacros 11.5) [[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] | ||
#[[iimTakeBrowserScreenshot]] | #[[iimTakeBrowserScreenshot]] | ||
#[[iimGetStopwatch]] (Old: [[iimGetLastPerformance]]) | #[[iimGetStopwatch]] (Old: [[iimGetLastPerformance]]) | ||
Line 220: | Line 229: | ||
# Error handling: [[Scripting Interface Return Codes]] | # Error handling: [[Scripting Interface Return Codes]] | ||
− | + | Refer to the [https://imacros.net/store/compare-versions/ iMacros Editions Comparison Table] to see which editions support the scripting interface (API) | |
− | ==Command Line Switches | + | ==Command Line Switches [[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]]== |
− | |||
− | |||
#[[-key]] | #[[-key]] | ||
− | #[[-kioskmode]] | + | #[[-kioskmode]] |
#[[-loop]] | #[[-loop]] | ||
#[[-macro]] | #[[-macro]] | ||
#[[-noexit]] | #[[-noexit]] | ||
− | #[[-silent]] | + | #[[-silent]] |
− | #[[-tray]] | + | #[[-tray]] |
#[[-profiler]] | #[[-profiler]] | ||
#[[-var_varname]] | #[[-var_varname]] | ||
+ | #[[-title]] Version 11.5 and above | ||
In addition to the switches above, the following switches can be used with the iMacros Sidebar for IE: | In addition to the switches above, the following switches can be used with the iMacros Sidebar for IE: | ||
− | #[[-timeout]] | + | #[[-timeout]] [[Image:Ie-icon.png|IE Plug-in]] |
− | #[[-iePrivate]] | + | #[[-iePrivate]] [[Image:Ie-icon.png|IE Plug-in]] |
+ | |||
+ | Refer to the [https://imacros.net/store/compare-versions/ iMacros Editions Comparison Table] to see which iMacros editions support the command line interface (CLI) | ||
==Error Handling== | ==Error Handling== |
Revision as of 13:19, 28 May 2018
A high-level overview on the different versions of iMacros can be found here
The browser icons listed below and on each command detail page denote browser compatibility. Commands that are supported in all browsers work exactly the same in each browser, so macros created in the iMacros Browser (or Internet Explorer) can be replayed in iMacros for Firefox and vice versa. Browser specific differences are automatically handled by iMacros.
iMacros Commands Reference
' (Comment) | |
ADD | |
BACK | |
CLEAR | |
CLICK | |
DISPLAY | |
DS | |
EVAL | |
EVENT | |
EXTRACT (Part of the TAG command) | |
FILEDELETE | |
FILTER | |
FRAME | |
IMAGECLICK | |
IMAGESEARCH | |
ONCERTIFICATEDIALOG | |
ONDIALOG | |
ONDOWNLOAD | |
ONERRORDIALOG | |
ONINSECURECONNECTION Version 10.3 and above | |
ONLOGIN | |
ONPRINT | |
ONSECURITYDIALOG | |
ONWEBPAGEDIALOG | |
PAUSE | |
PROMPT | |
PROXY | |
REFRESH | |
SAVEAS | |
SAVEITEM | |
SCREENSHOT | |
SEARCH | |
SET | |
SIZE | |
STOPWATCH | |
TAB | |
TAG | |
TRAY | |
URL | |
VERSION | |
WAIT | |
Error Codes | |
Tip: How to make if/then decisions with iMacros. |
Built-In Variables
Built-in variable names always start with an exclamation mark ("!"). See also this iMacros variable types overview.
!CLIPBOARD | |
!COLn | |
!DATASOURCE | |
!DATASOURCE_COLUMNS | |
!DATASOURCE_DELIMITER | |
!DATASOURCE_LINE | |
!DOWNLOADED_FILE_NAME Version 10.3 and above | |
!DOWNLOADED_SIZE Version 10.3 and above | |
!ENCRYPTION | |
!ENDOFPAGE | |
!ERRORIGNORE | |
!EXTRACT | |
!EXTRACT_TEST_POPUP | |
!EXTRACTDIALOG | |
!FAIL_ON_ALL_NAVIGATEERRORS | |
!FILELOG | |
!FILESTOPWATCH | |
!FILE_PROFILER | |
!FOLDER_DATASOURCE | |
!FOLDER_DOWNLOAD | |
!FOLDER_LOG | |
!FOLDER_MACROS | |
!FOLDER_STOPWATCH | |
!HTTP_ERRORCODE Version 11.5 and above | |
!IMAGEX | |
!IMAGEY | |
!LOOP | |
!MARKOBJECT | |
!NOW | |
!PLAYBACKDELAY | |
!POPUP_ALLOWED | |
!REPLAYSPEED | |
!REGION_BOTTOM | |
!REGION_LEFT | |
!REGION_RIGHT | |
!REGION_TOP | |
!SINGLESTEP | |
!STOPWATCHTIME | |
!STOPWATCH_HEADER | |
!TAGSOURCEINDEX | |
!TAGX | |
!TAGY | |
!TIMEOUT | |
!TIMEOUT_DOWNLOAD Version 10.3 and above | |
!TIMEOUT_MACRO | |
!TIMEOUT_PAGE | |
!TIMEOUT_STEP | |
!URLCURRENT | |
!USE_DOWNLOADMANAGER Version 10.3 and above | |
!USERAGENT | |
!VAR0...!VAR9 | |
!WAITPAGECOMPLETE | |
!WINDOW_TITLE Version 11.5 and above | |
!X_PERFLOG_NOTARGETPATH Version 10.3 and above |
User-defined Variables
User-defined variables are created with the SET and iimSet commands. Use iimSet to pass variables from script code to a macro. See also this iMacros variable types overview.
Scripting Interface Command Overview
The Scripting Interface works with the iMacros Browser, Internet Explorer, Firefox and Chrome (see iimOpen for details on how to switch between the browsers).
- iimOpen (old: iimInit())
- iimGetBrowserPid (iMacros 10.4)
- iimDisplay
- iimGetInterfaceVersion()
- iimGetErrorText (old: iimGetLastError())
- iimGetExtract (old: iimGetLastExtract())
- iimPlay and iimPlayCode()
- iimSet
- iimSetWindowTitle() (iMacros 11.5)
- iimTakeBrowserScreenshot
- iimGetStopwatch (Old: iimGetLastPerformance)
- iimGetPerformance (new method!)
- iimClose (old: iimExit)
- Error handling: Scripting Interface Return Codes
Refer to the iMacros Editions Comparison Table to see which editions support the scripting interface (API)
Command Line Switches
- -key
- -kioskmode
- -loop
- -macro
- -noexit
- -silent
- -tray
- -profiler
- -var_varname
- -title Version 11.5 and above
In addition to the switches above, the following switches can be used with the iMacros Sidebar for IE:
Refer to the iMacros Editions Comparison Table to see which iMacros editions support the command line interface (CLI)
Error Handling
iMacros includes detailed error handling.
iMacros Error Codes
Please see the list of general iMacros Error-Codes.
Scripting Interface Error Codes
Even a web browser crash or freeze does not stop the Scripting Interface. Instead, it will simply return an error code and you can start a new instance. Please see the list of Scripting Interface Return Codes.
Component for .NET
For details on the new iMacros Component for .NET, please the Component wiki page.