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

SDL_GetProcessProperties

Get the properties associated with a process.

Header File

Defined in <SDL3/SDL_process.h>

Syntax

SDL_PropertiesID SDL_GetProcessProperties(SDL_Process *process);

Function Parameters

SDL_Process *

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.

Remarks

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.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_CreateProcess
• SDL_CreateProcessWithProperties

---

CategoryAPI, CategoryAPIFunction, CategoryProcess

[ 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.