Simple command line arguments

 

Let us begin with a simple example:

ISLLightClient.exe --connect <session code>

 

Save ISL Light Client executable to a certain directory on your disk, open the Command Prompt (cmd) and type in the above line. It will start ISL Light Client executable in the current directory and automatically connect into an ISL Light session with provided <session code>.

 

Please refer to the following list for a detailed description of simple command line arguments:

--auto-close
 This option instructs ISL Light Client to close the program after the ISL Light session has ended. 
--connect <code>
 This option specifies a session code for ISL Light Client. When ISL LIght Client starts, it automatically tries to connect with the provided session code. 
--output-file
 This option specifies the location of the code_file.isl. 
--grid-conf
 This option is used to specify which grid to use. You can have several different connections so if you want to perform a login using cmd-line parameters then you also need to specify a connection to use. 
--notification-thread <thrd_ID> [--notification-message <msg>]
 Users that embed ISL Light Client in their application (product) should use this option. To specify windows message loop thread that will handle ISL Light notifications and the message send to that thread use option.
In case when no notification message is specified, WM_USER is used. Notification messages are sent from ISL Light with PostThreadMessage Window API call. Parameter wParam is a bit-field that defines the following ISL states:
0x00 - unconnected
0x01 - connecting with session code used in LPARAM
0x02 - connected
0x04 - streaming
0x40 - streaming with remote side having control
0x08 - receiving stream
0x10 - value of server ID in LPARAM
0x20 - value of session ID in LPARAM
0x8000 - error bit (lower portion of the code defines error code)
 
--session-message <user_defined_message>
 Custom message can be stored in ISL Conference Proxy logs by using this option. This message can be used for matching an ISL Light session ID with an external user-defined session ID. 
--silent
 When you specify this option, ISL Light will not ask for confirmation when terminating a connection. 
--touch-pad
 Use this option to open a touch pad on startup - useful for cases when a keyboard is not available and a touch-screen is used for input. 
--open-at-end <URL>
 This option instructs ISL Light to open the specified URL at the end of a session. 
--log-on-desktop
 Saves log file to desktop instead of application folder. 
--mtu [0,1,2]
 Set communication MTU (maximum transmission unit) in ISL Light Desk that will fix problems in some environments that don't have correct value of MTU in their network configuration. Value 0 means normal MTU while value 2 will set smallest value - 100 bytes in one IP packet. 
--add-title <title>
 Using this option you can add a string to ISL Light's title bar - it will be "ISL Light Desk <title>" (in case of ISL Light Desk) or "ISL Light Client <title>" (in case of ISL Light Client). 
--force-transport <transport type>
 Use this option to force a desired type of transport. The following values are available for <transport type>:
direct
wininet-http
wininet-https
wininet-html
httpt-direct
https-direct
httpt-proxy
https-proxy
Important: Please note that this is an advanced option and should only be used in specific situations. If you experience any problems with your connection, please come to our live chat or write an e-mail to support@islonline.com - we will check the situation and provide further instructions.		 
--proxy-address <server address>
 Use this option to specify the desired server address that should be used for connecting, e.g. server13.islonline.net for our Japanese server.
Important: Please note that this is an advanced option and should be used for troubleshooting purposes only. Default connection address takes advantage of our load balancing with many parameters and automatically redirects you to the optimal server (based on your location, our server load, our optimizations etc.). If you experience any problems with your connection, please come to our live chat or write an e-mail to support@islonline.com - we will check the situation and provide further instructions.		 
--proxy-address-hint <server ip>
 Use this option in combination with --proxy-address option. If you specify the proxy address as a DNS name, then you can use --proxy-address-hint to specify server's IP address to skip DNS resolving step. If the hint fails, then it is discarded and DNS resolving is used to find the server address from --proxy-address parameter. 
--httpt-port <port>
 Use this option to specify the port that should be used for connection (default is 7615 and should not be changed unless instructed to do so by our technical support team). 
--conn-options "<options>"
 Use this to pass special connect options such as http proxy address, username, password, transport boost. Example:
--conn-options "http_proxy=1.2.3.4&http_proxy_user=myuser&http_proxy_password=mypassword&boost=wsstun-direct"
Important: Please note that this is an advanced option and should only be used in specific situations. If you experience any problems with your connection, please come to our live chat or write an e-mail to support@islonline.com - we will check the situation and provide further instructions.		 
--customizations "<options>"
 Use this to pass special connect options such as http proxy address, username, password. Example:
--conn-options "http_proxy=1.2.3.4&http_proxy_user=myuser&http_proxy_password=
Important: Please note that this is an advanced option and should only be used in specific situations. If you experience any problems with your connection, please come to our live chat or write an e-mail to support@islonline.com - we will check the situation and provide further instructions.		 
--proxy-notification external_id=XXX
 Sets external Id field in session to be retrieved or searched later on through API. (added in ISL Light 3.5.2 and module 3.5.3)


Integration settings

Note: This settings only apply for situations where ISL Light is integrated into a 3rd party product and the session is not launched via ISL AlwaysOn. Using this commands in wrong configurations may result in unwanted consequences.

--run-in-console
 Use this option if ISL Light Client is being started via custom service running in Windows operating system. Services are running in a separate isolated Session away from the rest of the processes and so do processes that services spawn. If you pass this command line parameter when launching ISL Light Client, the application will automatically detect if it is running in Session 0 and move to a correct Session so that user can interact with it. Example:
"ISL Light Client.exe" --run-in-console <the rest of parameters>
Note: Command only works in Windows operating system.
 
--input-desktop-check default
 Passing this argument forces the ISL Light Client to check which input Desktop is currently active.  If the obtained desktop does not match the required desktop the process exits with errors. The following error codes are returned by the process:
  • 1 - Input desktop could not be obtained
  • 4 - Input desktop does not match the required

Use the required value "default" to check if default input desktop is present and active. Example:

"ISL Light Client.exe" --input-desktop-check default <the rest of parameters>


Note: Command only works in Windows operating system.



Tags: cl arguments, cli arg

Was this article helpful?

Cookie Consent

We use cookies to deliver and maintain ISL Online services, as well as to ensure the best browsing experience for our users. Three types of cookies are used:

Detailed information about the Cookies, their purpose, lifetime, expiration date and more can be found in our Cookie Policy and Privacy Policy. You can update your cookie preferences at any time.