iimInit()
From iMacros
(Redirected from iimInit)
Initializes the Scripting Interface. It opens a new instance of the iMacros Browser, IE or Firefox, or connects to an existing instance (depending on the specified parameters). If the command fails for any reason it returns an error code.
Contents |
Syntax
int ret_code = iimInit( String command_line [, boolean start_browser] [, String run_as_user, String run_as_password, String run_as_domain], Long timeout)
Parameters
- String command_line
- Specifies command line switches. All switches start with a dash (-). Possible switches are:
-
-ie Starts Internet Explorer instead of the iMacros Browser. Note that the iMacros sidebar need to be open in IE so that it re-opens automatically when IE is started.
-
-fx Starts Mozilla Firefox instead of the iMacros Browser. (iMacros for Firefox needs to be installed).
- -tray Starts the iMacros Browser in tray mode.
- -silent Starts the iMacros Browser in silent mode, i.e. tray mode without a tray icon.
- -runner Starts iMacros via the iimRunner tool.
- -useragent Change the iMacros user agent string. In Firefox, you can use the !USERAGENT variable instead.
- -key Start iMacros with the specified license key, for example as Player. This ignores any license key that the user might have entered. Currently, this switch is supported in the iMacros Browser and IE. For Firefox, a special registry tweak is available instead (contact tech support for details).
- Specifically for Firefox there are also the -fxVersion, -fxLocale and -fxProfile switches. Typically these specialized commands are "only" used for running automated tests with various Firefox versions. For IE there is no version switch as there can only be one IE version installed on a system.
- boolean start_browser
- Specifies whether to open a new instance of the iMacros Browser, Firefox or Internet Explorer.
- If set to false, iMacros tries to connect to an existing instance. If none is found, a new instance is created.
- Default is true.
- String run_as_user (Deprecated, please use the new iimRunner utility instead if you need to start iMacros under a certain user account)
- Username under whose account the iMacros Broser is started.
- String run_as_password (Deprecated, please use iimRunner instead)
- Password needed for the account specified in run_as_user.
- String run_as_domain (Deprecated, please use iimRunner instead)
- Domain in which the username given in run_as_user is valid.
- Long timeout
- iimInit waits <timeout> seconds for the iMacros Browser, Firefox or IE to start. Default is 300 seconds. Note that on systems with a heavy CPU load (near or equal 100%) it can take around 30s for a web browser to start. Example: You can change the timeout to 90s with iret = iim1.iimInit ("", "true", "", "", "", 90)
Return values
- 1 Completed ok
- -1 Could not start the specified web browser
- -3 Timeout (In the trial version this error can also occur if you do not press the iMacros trial version reminder screen "Continue" button to late. This issue can never occur in the full version.)
- -6 (only with -runner flag) iimRunner not running. Please start iimRunner.exe first. You find this file in the iMacros program directory.
- -7 (only with -runner flag) The max. number of allowed iMacros instances is reached. You can change this limit in the simple.xml file. You find this file in the iMacros program directory. This error also occurs if there is no iimrunner.xml file.
For more information see the complete list of Scripting Interface Return Codes.
Examples
Initialize the Scripting Interface in silent mode (iMacros not visible in taskbar or tray - Visual Basic Script example):
Dim imacros, iret
Set imacros = CreateObject("imacros")
iret = imacros1.iimInit("-silent")
Initialize the Scripting Interface connection to an existing Internet Explorer instance:
Dim imacros, iret
Set imacros = CreateObject("imacros")
iret = imacros1.iimInit("-ie", FALSE)
Start Firefox via iimRunner :
Dim imacros, iret
Set imacros = CreateObject("imacros")
iret = imacros1.iimInit("-fx -runner")
