SDL Wiki
(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_CreateProcess

Create a new process.

Header File

Defined in <SDL3/SDL_process.h>

Syntax

SDL_Process* SDL_CreateProcess(const char * const *args, bool pipe_stdio);

Function Parameters

const char * const * args the path and arguments for the new process.
bool pipe_stdio true to create pipes to the process's standard input and from the process's standard output, false for the process to have no input and inherit the application's standard output.

Return Value

(SDL_Process *) Returns the newly created and running process, or NULL if the process couldn't be created.

Remarks

The path to the executable is supplied in args[0]. args[1..N] are additional arguments passed on the command line of the new process, and the argument list should be terminated with a NULL, e.g.:

const char *args[] = { "myprogram", "argument", NULL };

Setting pipe_stdio to true is equivalent to setting SDL_PROP_PROCESS_CREATE_STDIN_NUMBER and SDL_PROP_PROCESS_CREATE_STDOUT_NUMBER to SDL_PROCESS_STDIO_APP, and will allow the use of SDL_ReadProcess() or SDL_GetProcessInput() and SDL_GetProcessOutput().

See SDL_CreateProcessWithProperties() for more details.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.

See Also


CategoryAPI, CategoryAPIFunction, CategoryProcess


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.