SDL_GetIOStatus(3)

SDL_GetIOStatus3

Query the stream status of an sdl_iostream .

Usage

#include "SDL3/SDL.h"

SDL_IOStatus SDL_GetIOStatus(SDL_IOStream *context);

Header file

Defined in SDL3/SDL_iostream.h

Overview

This information can be useful to decide if a short read or write was due to an error, an EOF, or a non-blocking operation that isn't yet ready to complete.

An SDL_IOStream

SDL_ReadIO
or SDL_WriteIO
call; don't expect it to change if you just call this query function in a tight loop.

Function parameters

context

the SDL_IOStream
to query.

Return value

( SDL_IOStatus ) Returns an SDL_IOStatus
enum with the current state.

Thread safety

This function is not thread safe.

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.