SDL_GetProcessProperties - Man Page
Get the properties associated with a process.
Header File
Defined in SDL3/SDL_process.h
Synopsis
#include "SDL3/SDL.h" SDL_PropertiesID SDL_GetProcessProperties(SDL_Process *process);
Description
The following read-only properties are provided by SDL:
· SDL_PROP_PROCESS_PID_NUMBER : the process
ID of the process.
· SDL_PROP_PROCESS_STDIN_POINTER : an
SDL_IOStream
that can be used to write input to the
process, if it was created with
SDL_PROP_PROCESS_CREATE_STDIN_NUMBER set to SDL_PROCESS_STDIO_APP .
· SDL_PROP_PROCESS_STDOUT_POINTER : a
non-blocking SDL_IOStream
that can be used to read output
from the process, if it was created with
SDL_PROP_PROCESS_CREATE_STDOUT_NUMBER set to SDL_PROCESS_STDIO_APP .
· SDL_PROP_PROCESS_STDERR_POINTER : a
non-blocking SDL_IOStream
that can be used to read error
output from the process, if it was created with
SDL_PROP_PROCESS_CREATE_STDERR_NUMBER set to SDL_PROCESS_STDIO_APP .
· SDL_PROP_PROCESS_BACKGROUND_BOOLEAN :
true if the process is running in the background.
Function Parameters
- process
the process to query.
Return Value
( SDL_PropertiesID ) Returns a valid property ID on success or 0 on failure; call SDL_GetError () for more information.
Thread Safety
It is safe to call this function from any thread.
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_CreateProcess(3), ·(3), SDL_CreateProcessWithProperties(3)
Referenced By
SDL_CreateProcess(3), SDL_CreateProcessWithProperties(3), SDL_ProcessIO.3type(3).