Command line parameters
Comfort On-Screen Keyboard Pro (CKeyboard.exe) accepts optional command line parameters. These parameters can be useful for developers and for calling our application from other software.
/HELP and /?
Displays the list of valid command line parameters in a message box.
/CLOSE
Closes the previously launched instance of the application together with the current one. If no other instance is running, the current instance only performs the specified tasks (for example, restores settings using the /RESTORE parameter) and then exits without showing the main window.
/SHOWKEYBOARD
Forcibly shows the on-screen keyboard when the application is launched. Normally, the on-screen keyboard is shown only if it was visible the last time the application was closed.
/HIDEKEYBOARD
Starts the application with the on-screen keyboard hidden. Normally, the on-screen keyboard is shown if it was visible the last time the application was closed.
/COMMON
Starts the application with the same settings for all users.
This parameter instructs the application to save its settings to the following registry key: HKEY_LOCAL_MACHINE\SOFTWARE\ComfortSoftware\CKeyboard
Normally, they are saved to this registry key: HKEY_CURRENT_USER\SOFTWARE\ComfortSoftware\CKeyboard
Note (version 9.6 and later): If Data\CommonSettings.ini exists, settings are saved to this file.
/INIFILE
Instructs the application to save and read its settings from the INI file. Normally, the settings are stored in the registry.
The settings will be stored to the Backup.ini file located in the application installation folder (in the Data subfolder).
How to use:
Save your settings to "C:\Program Files\ComfortKeyboard\Data\Backup.ini" file, and launch "CKeyboard.exe /INIFILE". In this case, the application saves and reads the settings from the Backup.ini file.
/OPTIONS
Opens the application settings window.
/CHANGELANGUAGE <code>
Switches the input language. If used without an input language code, the application switches to the next available input language or layout.
For example: "C:\Program Files\ComfortKeyboard\CKeyboard.exe" /CHANGELANGUAGE 0409
/RESTORE
Instructs the application to load settings from the INI file specified in the command line. If another instance of the application is already running, the settings from the INI file will be loaded into it. You can save the settings to the INI file by opening the Settings window and switching to the Advanced section.
For example: "C:\Program Files\ComfortKeyboard\CKeyboard.exe" /RESTORE "C:\Program Files\ComfortKeyboard\Settings.ini"
/SAVEPROFILE
Saves all application data to a single compressed backup file: the settings, keyboard files, and dictionaries. The same backup can be created by clicking the Back Up All Data button in the application settings window.
For example: "C:\Program Files\ComfortKeyboard\CKeyboard.exe" /SAVEPROFILE "C:\Backups\ComfortOn-ScreenKeyboardProBackup.kbpack"
/APPLYPROFILE
Restores all application data from the backup file created with the /SAVEPROFILE parameter. The file signature, the format version, and the target application are verified before restoring. If another instance of the application is running, it is closed automatically and started again after the restore. This parameter requires version 10 or later and is not available in the trial version.
Add the /SILENT parameter to suppress all messages: the result is reported by the exit code only.
For example: "C:\Program Files\ComfortKeyboard\CKeyboard.exe" /APPLYPROFILE "C:\Backups\ComfortOn-ScreenKeyboardProBackup.kbpack" /SILENT
Exit codes:
0 - success;
1 - the backup file is not specified or does not exist;
2 - the backup file is damaged or its signature is invalid;
3 - the backup file belongs to another application or was created by a newer version of the application;
4 - an error occurred while creating or applying the backup;
5 - restoring is not available in the trial version.
The exit codes apply to both /SAVEPROFILE and /APPLYPROFILE.
/M <num>
Launches several instances of the program, where <num> is the number of instances to be launched. Each instance will have its own settings. By default, you can launch one instance only.
/TURNON and /TURNOFF
Completely turn the application on or off. Use the /SHOWKEYBOARD or /HIDEKEYBOARD parameter to show or hide the on-screen keyboard.
/SAFEMODE
Launches the application in safe mode. Some features of the application will be disabled.
/DEBUG
Instructs the application to create the Log.txt file in the application folder (in the Data subfolder). The log file will contain details about the application’s activity, which can be a helpful debugging aid.
The information contained in the log file is technical in nature and therefore not intended to be understandable by end users.
If a file with the specified name already exists in the application folder, it will be overwritten.
/EVENTLOG
Instructs the application to create different log files for every startup. See the Data subfolder in the application folder.
You can also add the DWORD parameter EventLog=1 in the registry to do the same.
/REMOTECONTROLMODE
Enables the special mode for remote control devices. In this mode, you can use the arrow keys to move around the keyboard, and use the Enter key to press the currently selected key.