This guide provides instructions on using command-line arguments options, allowing users to customize ISL Light Client behavior for specific requirements. Command-line arguments can be divided on two parts.
- Command-Line Arguments (current page)
- Command-Line Arguments with Events (next article)
Example:
Let's dive in with a simple example:
ISLLightClient.exe --connect <session code>
By executing this command, ISL Light Client will automatically connect into an ISL Light session with provided <session code>.
Join Commands
These command lines are used when creating a session with session code.
| Command | Description |
|---|---|
| --silent |
When you specify this option, ISL Light will not ask for confirmation when terminating a connection. Example: ISLLightClient.exe --silent |
| --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. Example: ISLLightClient.exe --touch-pad |
| --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. Example: ISLLightClient.exe --connect "12345678" |
|
--check-user (true|false) |
When check-user is set to true and ISL Light receives the session code the user has to manually click "connect" to establish a session (session does not start automatically). This is useful if user has an antivirus software which runs the executable in the sandbox environment to make sure its safe. Without setting this parameter the session would be established to the sandbox computer instead of the target one. Example: ISLLightClient.exe --connect [session_code] --check-user "true" |
Customization Commands
These command lines are used when logging into ISL Light.
| Command | Description |
|---|---|
| --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). Example: ISLLightClient.exe --add-title “My Company Name” |
| --open-at-end <URL> |
This option instructs ISL Light to open the specified URL at the end of a session. Example: ISLLightClient.exe --open-at-end “www.islonline.com” |
| --auto-close |
This option instructs ISL Light Client to close the program after the ISL Light session has ended. Example: ISLLightClient.exe --auto-close |
Network Commands
These command lines are used for networking, and advanced features.
| Command | Description |
|---|---|
| --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:
|
| --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. Example: ISLLightClient.exe --session-message "Testing message" |
| --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 the correct value of MTU in their network configuration. Value 0 means normal MTU while value 2 will set the smallest value - 100 bytes in one IP packet. Example: ISLLightClient.exe --mtu “0” |
| --force-transport <transport type> |
Use this option to force a desired type of transport. The following values are available for <transport type>:
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. Example: ISLLightClient.exe --force-transport "direct" |
| --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.
Example: ISLLightClient.exe --proxy-address "server13.islonline.net" |
| --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. Example: ISLLightClient.exe --proxy-address "server13.islonline.net" --proxy-address-hint "156.98.144.1" |
| --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). Example: ISLLightClient.exe --httpt-port "443" |
| --conn-options <options> |
Use this to pass special connect options such as HTTP proxy address, username, password, and transport boost. Example: ISLLightClient.exe --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. |
| --log-on-desktop |
Saves log file to desktop instead of application folder. Example: ISLLightClient.exe --log-on-desktop |
| --customizations <options> |
Use this to pass special connect options such as http proxy address, username, 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. Example: ISLLightClient.exe --customizations <options> |
| --proxy-notification external_id=XXX | Sets external Id field in session to be retrieved or searched later on through API. |
Integration Commands
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.
| Command | Description |
|---|---|
| --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> |
| --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:
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> |
Next Article:
Command Line Arguments on Event