diff --git a/doc/classes/SubProcess.xml b/doc/classes/SubProcess.xml new file mode 100644 index 000000000..a5097ccdf --- /dev/null +++ b/doc/classes/SubProcess.xml @@ -0,0 +1,99 @@ + + + + Run and manage sub processes. + + + This class grants acess to run and manage sub processes with more fine grained control compared to OS.execute(). + + + + + + + + Returns the data returned by the last [member poll] run. + + + + + + Returns the exit code of the process. + + + + + + Returns the exit code of the running process, or 0. + + + + + + Returns whether a subprocess is running. + + + + + + Reads from the running process's console output if applicable. + + + + + + + Pipe data to the running process. + + + + + + + Send a signal to the runnign process. + + + + + + Start a subprocess according to the properties. Will return ERR_BUSY if something is already running. + If [member blocking] is true, and [member read_output] is also true, the output can be read from [member get_data()] after this method returns. + If [member blocking] is false, and [member read_output] is true, the output can be read (usually line-by-line) from [member get_data()] after every [member poll()] calls. + + + + + + Stop the running subprocess. + + + + + + The arguments that will be passed to the executable. + + + Whether to block until the subprocess finishes or not. + + + The executable's path that will be run. + + + Whether to open a console window or not. Windows only. + + + Controls whether to read any output of the subprocess or not. + + + Controls whether to read the standard output of the subprocess or not. + + + Controls whether to read the standard error output of the subprocess or not. + + + Controls whether to use a mutex when reading the output of the subprocess. + + + + +