diff options
Diffstat (limited to 'doc/classes/OS.xml')
| -rw-r--r-- | doc/classes/OS.xml | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 522a00385a..80febff4af 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="OS" inherits="Object" category="Core" version="3.0-rc1"> +<class name="OS" inherits="Object" category="Core" version="3.0-stable"> <brief_description> Operating System functions. </brief_description> @@ -87,7 +87,18 @@ <argument index="3" name="output" type="Array" default="[ ]"> </argument> <description> - Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. + Execute the file at the given path, optionally blocking until it returns. + Platform path resolution will take place. The resolved file must exist and be executable. + Returns a process id. + For example: + [codeblock] + var output = [] + var pid = OS.execute('ls', [], true, output) + [/codeblock] + If you wish to access a shell built-in or perform a composite command, a platform specific shell can be invoked. For example: + [codeblock] + var pid = OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) + [/codeblock] </description> </method> <method name="find_scancode_from_string" qualifiers="const"> |