gio/org.gtkkn.bindings.gio/SubprocessLauncher

SubprocessLauncher

open class SubprocessLauncher(val gioSubprocessLauncherPointer: <Error class: unknown class><<Error class: unknown class>>)

This class contains a set of options for launching child processes, such as where its standard input and output will be directed, the argument list, the environment, and more.

While the class@Gio.Subprocess class has high level functions covering popular cases, use of this class allows access to more advanced options. It can also be used to launch multiple subprocesses with a similar configuration.

Skipped during bindings generation

method spawn: Varargs parameter is not supported
method flags: Property has no getter nor setter

Since

2.40

Constructors

SubprocessLauncher

constructor(flags: SubprocessFlags)

Creates a new #GSubprocessLauncher.

constructor(gioSubprocessLauncherPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gioSubprocessLauncherPointer

val gioSubprocessLauncherPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

open fun close()

Closes all the file descriptors previously passed to the object with g_subprocess_launcher_take_fd(), g_subprocess_launcher_take_stderr_fd(), etc.

getenv

open fun getenv(variable: String): String?

Returns the value of the environment variable @variable in the environment of processes launched from this launcher.

setChildSetup

open fun setChildSetup(childSetup: <Error class: unknown class>)

Sets up a child setup function.

setCwd

open fun setCwd(cwd: String)

Sets the current working directory that processes will be launched with.

setenv

open fun setenv(variable: String, value: String, overwrite: Boolean)

Sets the environment variable @variable in the environment of processes launched from this launcher.

setEnviron

open fun setEnviron(env: List<String>)

Replace the entire environment of processes launched from this launcher with the given 'environ' variable.

setFlags

open fun setFlags(flags: SubprocessFlags)

Sets the flags on the launcher.

setStderrFilePath

open fun setStderrFilePath(path: String? = null)

Sets the file path to use as the stderr for spawned processes.

setStdinFilePath

open fun setStdinFilePath(path: String? = null)

Sets the file path to use as the stdin for spawned processes.

setStdoutFilePath

open fun setStdoutFilePath(path: String? = null)

Sets the file path to use as the stdout for spawned processes.

spawnv

open fun spawnv(argv: List<String>): <Error class: unknown class><Subprocess>

Creates a #GSubprocess given a provided array of arguments.

takeFd

open fun takeFd(sourceFd: <Error class: unknown class>, targetFd: <Error class: unknown class>)

Transfer an arbitrary file descriptor from parent process to the child. This function takes ownership of the @source_fd; it will be closed in the parent when @self is freed.

takeStderrFd

open fun takeStderrFd(fd: <Error class: unknown class>)

Sets the file descriptor to use as the stderr for spawned processes.

takeStdinFd

open fun takeStdinFd(fd: <Error class: unknown class>)

Sets the file descriptor to use as the stdin for spawned processes.

takeStdoutFd

open fun takeStdoutFd(fd: <Error class: unknown class>)

Sets the file descriptor to use as the stdout for spawned processes.

unsetenv

open fun unsetenv(variable: String)

Removes the environment variable @variable from the environment of processes launched from this launcher.