This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
Description
Run an operating system command.
Syntax
pID = OS_Shell(Command[, WindowStyle[, Mode]])
Returns
Number.
•When OS_Shell is executed in %OS_SHELL_ASYNC mode, it will return the process id of the executed command.
•When OS_Shell is executed in %OS_SHELL_SYNC mode, it will return the executed application exit code. This is useful when executing Console applications that return code to signal error or status situations.
Parameters
Name |
Type |
Optional |
Meaning |
Command |
String |
No |
Command string to execute along with and any required arguments or command-line switches. |
WindowStyle |
Number |
Yes |
A number corresponding to the style of the window in which the child process is to be executed. If WndStyle is omitted, the program is opened normal with focus. See OS_Equates for possible values |
Mode |
Number |
Yes |
If present, it can assume one of two options: the command will be executed and the script will wait for the command to finish the command will be executed and the script will immediatelly continue its execution |
Remarks
Execution can be run in asynchronous or synchronous mode.
Under asynchronous mode, script continues uninterrupted while Command is executed.
Under synchronous mode, script will wait for Command execution.
Restrictions
See also
Examples