SDL_GetProcessOutput(3)

SDL_GetProcessOutput3

Get the sdl_iostream associated with process standard output.

Usage

#include "SDL3/SDL.h"

SDL_IOStream * SDL_GetProcessOutput(SDL_Process *process);

Header file

Defined in SDL3/SDL_process.h

Overview

The process must have been created with

SDL_CreateProcess () and pipe_stdio set to true, or with SDL_CreateProcessWithProperties () and

SDL_PROP_PROCESS_CREATE_STDOUT_NUMBER set to SDL_PROCESS_STDIO_APP .

Reading from this stream can return 0 with

SDL_GetIOStatus () returning

SDL_IO_STATUS_NOT_READY
if no output is available yet.

Function parameters

process

The process to get the output stream for.

Return value

( SDL_IOStream
*) Returns the output stream or NULL 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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.