Function

GLib-2.0 ▶ GLib ▶ spawn_sync

  • Executes a child synchronously (waits for the child to exit before returning).

    All output from the child is stored in standard_output and standard_error, if those parameters are non-null. Note that you must set the GLib.SpawnFlags.STDOUT_TO_DEV_NULL and GLib.SpawnFlags.STDERR_TO_DEV_NULL flags when passing null for standard_output and standard_error.

    If wait_status is non-null, the platform-specific status of the child is stored there; see the documentation of g_spawn_check_wait_status() for how to use and interpret this. On Unix platforms, note that it is usually not equal to the integer passed to exit() or returned from main().

    Note that it is invalid to pass GLib.SpawnFlags.DO_NOT_REAP_CHILD in flags, and on POSIX platforms, the same restrictions as for g_child_watch_source_new() apply.

    If an error occurs, no data is returned in standard_output, standard_error, or wait_status.

    This function calls g_spawn_async_with_pipes() internally; see that function for full details on the other parameters and details on how these functions work on Windows.

    Parameters

    • working_directory: string

      child's current working directory, or null to inherit parent's

    • argv: string[]

      child's argument vector, which must be non-empty and null-terminated

    • envp: string[]

      child's environment, or null to inherit parent's

    • flags: GLib.SpawnFlags

      flags from GLib.SpawnFlags

    • child_setup: SpawnChildSetupFunc

      function to run in the child just before exec()

    Returns [boolean, Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>, number]

    true on success, false if an error was set