asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #15917 from brainsick/doc-os-commands

Browse source 
clarify OS.execute usage
This commit is contained in:
Rémi Verschelde 2018-01-21 21:56:05 +01:00 committed by GitHub
commit d8390105c3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/classes/OS.xml
View file

@ -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% &amp;&amp; dir'], true, output)
[/codeblock]
</description>
</method>
<method name="find_scancode_from_string" qualifiers="const">