native_process_capture.h

Go to the documentation of this file.

/**
 * @file
 * @brief Declares child-process capture helpers.
 */
 
#ifndef PHAROS_NATIVE_PROCESS_CAPTURE_H
#define PHAROS_NATIVE_PROCESS_CAPTURE_H
 
#include <stddef.h>
 
/** @name Process capture helpers
 * @{
 */
/**
 * @brief Executes a process and captures its combined output.
 * @param argv Null-terminated argv array for the child process.
 * @param output Destination for the allocated output buffer.
 * @param output_len Optional destination for the output length.
 * @return Process exit status, or a non-zero launcher status on failure.
 */
int capture_execv_output_native(char *const argv[], char **output, size_t *output_len);
/**
 * @brief Executes a process with injected environment values and captures its output.
 * @param argv Null-terminated argv array for the child process.
 * @param env_keys Environment variable names to set.
 * @param env_values Environment variable values paired with env_keys.
 * @param env_count Number of environment pairs to apply.
 * @param output Destination for the allocated output buffer.
 * @param output_len Optional destination for the output length.
 * @return Process exit status, or a non-zero launcher status on failure.
 */
int capture_execv_output_env_native(char *const argv[], const char *env_keys[], const char *env_values[], size_t env_count, char **output, size_t *output_len);
/**
 * @brief Executes a process with injected environment values and captures stdout and stderr separately.
 * @param argv Null-terminated argv array for the child process.
 * @param env_keys Environment variable names to set.
 * @param env_values Environment variable values paired with env_keys.
 * @param env_count Number of environment pairs to apply.
 * @param stdout_output Destination for the allocated stdout buffer.
 * @param stdout_len Optional destination for the stdout length.
 * @param stderr_output Destination for the allocated stderr buffer.
 * @param stderr_len Optional destination for the stderr length.
 * @return Process exit status, or a non-zero launcher status on failure.
 */
int capture_execv_output_split_env_native(char *const argv[], const char *env_keys[], const char *env_values[], size_t env_count, char **stdout_output, size_t *stdout_len, char **stderr_output, size_t *stderr_len);
/**
 * @brief Executes a process and captures its combined output text.
 * @param argv Null-terminated argv array for the child process.
 * @param output Destination for the allocated output buffer.
 * @return Process exit status, or a non-zero launcher status on failure.
 */
int run_process_capture_native(char *const argv[], char **output);
 
 
/** @} */
#endif