FlexScan3D Command Line Interface

The FlexScan3D command line interface is accessible by calling FlexScan3D.exe on the command line or through the API DLL. A path that contains spaces must be enclosed in double quotes.

Example: Flexscan3d.exe script C:\Users\User\Documents\Scripts\MyScript.script\

To communicate from the script to the calling application, variables can be set in the script which can then be queried using the FS3D_ScriptQuery() function after the script has completed. For more about writing scripts, see Automation

interactive

Usage: interactive [console]
Example: Flexscan3d.exe interactive

Starts FlexScan3D in Interactive mode to allow multiple commands to be sent without starting and stopping all the time. Including the word "console" causes FlexScan3D to open up a command-line like console for the user to type in. Otherwise the calling application is responsible for managing the input and output pipes. Programming languages that can read / write the standard console input / output streams can use this interface (just ensure that all commands end with a newline (\n) character).

To test the interface we recommend using "FlexScan3D.exe interactive console"

script

Usage: script <script file>
Example: Flexscan3d.exe script C:\Users\User\Documents\Scripts\MyScript.script

Runs a script file. The path and file name can contain Unicode characters.

scriptline

Usage: scriptline <script>
Example: Flexscan3d.exe scriptline "a = 4"

Runs a line of script. Note: backslashes in path names will need to be escaped to work properly (replace "\" with "\\").

scriptquery

Usage: scriptquery <script variable>
Example: Flexscan3d.exe scriptquery "a"

Returns the value of the specified script variable.

exit

Usage: exit
Example: Flexscan3d.exe exit

Requests a clean shutdown from FlexScan3D and the end of interactive mode.