sdlGetProcessProperties function

int sdlGetProcessProperties(Pointer<SdlProcess> process)

Get the properties associated with a process.

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.

\param process the process to query. \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

\threadsafety It is safe to call this function from any thread.

\since This function is available since SDL 3.1.3.

\sa SDL_CreateProcess \sa SDL_CreateProcessWithProperties

extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetProcessProperties(SDL_Process *process)

Implementation

int sdlGetProcessProperties(Pointer<SdlProcess> process) {
  final sdlGetProcessPropertiesLookupFunction = libSdl3.lookupFunction<
      Uint32 Function(Pointer<SdlProcess> process),
      int Function(Pointer<SdlProcess> process)>('SDL_GetProcessProperties');
  return sdlGetProcessPropertiesLookupFunction(process);
}