Arguments

commands

Single text containing Windows, Linux, or MacOS instructions sent to the OS command interpreter.

status

integer flag: -1 if the commands can't be executed (for instance due to unsufficient memory). If commands is executed (successfully or not) : exit code number returned by the Operating System (OS) interpreter.

With Windows, 0 is most often returned in case of successful execution.

Description

host(…)

• creates a session of the OS command interpreter (sh with Linux, or cmd.exe with Windows).
• sends the given commands to it,
• lets them be executed by the OS interpreter,
• receives all the messages normally displayed in the OS interpreter terminal,
• and closes the OS interpreter session.

The opened session of the OS interpreter is a fork of the session homing the current Scilab session. As a consequence, it has the following properties: Its starting current working directory (CWD) is the current one in the Scilab session when running host(…). Its starting environment variables are copied from the OS interpreter session homing the current Scilab session. They can be modified using setenv, before calling host(). Changing the CWD or/and the environment variables with instructions in commands does not change them in the Scilab session or/and in the underlying OS interpreter session homing it.

The host(…) results as standard output and standard errors are written in the terminal from which the Scilab session has been launched (a.k.a. the consolebox for MS Windows)..

host() shall be preferred to its unix() alias, whose name is misleading.

On MS Windows, host("cls") CLears the consolebox Screen.

Examples

pwd     // Current working directory of the Scilab session
if getos()=="Windows"
    host cls;
    consolebox on;
    host cd;        // Starting working directory in the OS interpreter session
else
    host pwd;
end
// The paths in the OS terminal/consolebox and in the Scilab console are the same  <<==

host cls;
host "echo Scilab host() function";
host "echo A & echo BC";
host("echo DEF"+ascii(10)+"echo G");
host("echo Current working directory: & cd");
host dira;   // => error: unknown command

Scilab host() function
A
BC
DEF
Current working directory:
C:\Scilab\tests
'dira' is not a known internal or external command, executable program, or batch file.

setenv TEST AAAA;
getenv NUMBER_OF_PROCESSORS
host cls;
host "echo %TEST%";
host "echo %USERNAME% %NUMBER_OF_PROCESSORS%";
host "set TEST=BBBB";
getenv TEST

--> setenv TEST AAAA;
--> getenv NUMBER_OF_PROCESSORS
 ans  =
 2

--> host cls;
--> host "echo %TEST%";
: AAAA

--> host "echo %USERNAME% %NUMBER_OF_PROCESSORS%";
: Samuel 2

--> host "set TEST=BBBB"  // well done:
 ans  =
   0.

--> getenv TEST
 ans  =
 AAAA

function openURL(url)
    if getos()=="Windows"
        winopen(url)
    elseif getos()=="Linux"
        host("xdg-open """+url+"""")
    elseif getos()=="Darwin"         // Mac OS
        host("open """+url+"""")
    else
        warning("openURL: unknown OS")
    end
endfunction

// call it:
openURL("https://help.scilab.org/docs/current/en_US/host.html")

See also

• consolebox — shows or hides the MS Windows terminal running the Scilab session
• getos — return Operating System name and version
• setenv — set the value of an environment variable
• unix_g — executes some Windows, Linux or MacOS instructions: output in variables
• unix_s — executes some Windows, Linux or MacOS instructions: output canceled (Silent mode)
• unix_w — executes some Windows, Linux or MacOS instructions: output in Scilab's console
• unix_x — executes some Windows, Linux or MacOS instructions: output in a dedicated window
• dos — executes some DOS instructions (Windows only)
• powershell — executes a command with the Windows powershell interpreter (Windows only)
• List of MS Windows exit codes