Library: Process execution (OMPROCESS) Import: omprocess.xmd

Return type: command-line-type Returns: Command-line object built from the executable name and the command-line arguments provided.

Declaration

export command-line-type function
        executable-name           value     string e-name
                        arguments read-only string arguments optional 
 

Argument definitions

e-name

is the name of the executable

arguments

is a STRING shelf, each item of which contains a single command-line argument to be passed to the executable when the process is launched.

The executable-name function is used to create a representation of a command-line that can be used to launch a process using the execute function. Compared to the command-lineCOMMAND-LINE function, the executable-name function allows a command-line to be parsed into arguments in a way best suited to the application, since arguments are provided as items on a shelf.

The e-name argument is resolved to an actual executable program in a platform-dependent manner. On Unix platforms, the environment variable path will be used to search for the executable.

The arguments shelf is passed to the executable as the collection of its command-line arguments. On Unix, these are passed as-is, one command-line argument per item value of the arguments shelf. On Windows, the value of the items of the arguments shelf are concatenated, separated by a space, and it is this resulting string which is passed as the command-line. In either case, the shelf item keys are not used.

Other Library Functions    command-line    executable-name    execute    glob    omprocess-version

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]