Skip to main content

Command Line Control

The software can be controlled by other Windows applications via command line commands. Several options are available to open files or run predictions with calibration models automatically on startup of the application. Typically, these commands are applied via a DOS prompt as described in the following:

  1. From the Windows Start menu, choose the Run... command.

  2. In the dialog type cmd and press the RETURN-key.
    This opens a DOS prompt window.

  3. In the DOS prompt window navigate to the installation directory of the software using shell commands like cd\.

  4. Type the software executable name plus the command line switch you like to apply.

The general syntax for a command line is the following:

software.exe [FILES] [SWITCHES]

The general syntax for SWITCHES is the following:

software.exe /SWITCH:[VALUE]

Several SWITCHES can be combined by separating them with a white space character.

Command Line Options​

Several command line options are available as described in the following:

Command Line Help​

Type the software executable name plus the command line switch /? to get an information on all command line options:

software.exe /?

Open Files​

The FILES parameter allows you to provide a list of file names being opened by the software on startup. The list may include valid file wildcards like * and ?. File names need to be separated by a white space character.

Example:

software.exe file1.spc *.dx

This opens the file named "file1.spc" plus all files with extension "dx" in the application directory.

Loading or Creating a Project​

A project can be loaded or created using the following SWITCH:

  • /project

If the denoted project name cannot be found, a new project is created with the given name.

Example:

software.exe /project:MyProject.project

This loads or creates a project named"MyProject".

Creating Folders in a Project​

New folders in an open project can be created using the following SWITCH:

  • /folder

This command can only be used together with the /project SWITCH.

Example:

software.exe /project:MyProject.project /folder:MyFolder

This command creates a folder named "Myfolder" in the project "MyProject".

Adding Data to a Project or Folder​

Files can be added to a folder or project by combining the /project and the /folder switch as follows:

software.exe file1.spc /project:MyProject.project /folder:MyFolder

This command adds the file "file1.spc" to the folder named "Myfolder" in the project "MyProject". If the folder or project does not exist, they will be created automatically.

Predicting unknown Samples​

The software can be used as an external prediction tool for unknown samples, e.g in online analysis. The software is run with an unknown spectrum file and a project containing calibrations to be evaluated. The prediction result which is a number or text is returned to the standard output device. It can be redirected easily into a file.

The following SWITCHES are supported in this section:

  • /PredictProject
    Denotes the project name, where calibrations are stored. This must be the exact name. If the name contains white spaces, the name needs to be put into quotation marks.

  • /CalibrationModel
    Denotes the calibration model name. This must be the exact name. If the name contains white spaces, the name needs to be put into quotation marks.

  • /NoMessageBox
    Runs the prediction tool silent.

Examples:

software.exe file1.spc /PredictProject:MyProject.project /CalibrationModel:MyPLS1

This command runs a prediction on "file1.spc" with calibration "MyPLS1" from project "MyProject". The result is returned to the standard output device and a message box is shown with the result.

software.exe file1.spc /PredictProject:MyProject.project /CalibrationModel:MyPLS1 /NoMessageBox

This command runs a prediction on "file1.spc" with calibration "MyPLS1" from project "MyProject". The result is returned to the standard output device. The application is run in silent mode. No message boxes are shown.

software.exe file1.spc /PredictProject:MyProject.project /CalibrationModel:MyPLS1 /NoMessageBox > MyResult.txt

This command runs a prediction on "file1.spc" with calibration "MyPLS1" from project "MyProject". The result is returned to the file "MyResult.txt". The application is run in silent mode. No message boxes are shown.

Low Level Command Line Controls​

The following command line controls are for experts only.

Clean User Settings​

Sometimes users want to restore factory default settings for the application parameters. This can be easily achieved using the following SWITCH:

  • /cleansettings

software.exe /cleansettings

Resetting the application settings may also be achieved by using the command Reset Application Settings in the Workspace Submenu  of the Window menu.

Delete Files On Exit​

All files being loaded on startup of the application can be automatically removed from your hard disc when the application is closed.

The following SWITCH is supported:

  • /DeleteFilesOnExit

This switch is used in case the application is used as a data viewer. Temporary data provided by other applications needs to be opened with the software, but they might be of no use anymore after closing the software.

software.exe file1.spc /DeleteFilesOnExit

This command opens the file "file1.spc" on startup of the application. After closing the application, the file is permanently removed from the hard disc.