NAME¶

SDL_GetIOStatus - Query the stream status of an SDL_IOStream.

SYNOPSIS¶

#include <SDL3/SDL_iostream.h>

SDL_IOStatus SDL_GetIOStatus(SDL_IOStream *context);

DESCRIPTION¶

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's status is only expected to change after a 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¶

Returns an SDL_IOStatus enum with the current state.

THREAD SAFETY¶

Do not use the same SDL_IOStream from two threads at once.

AVAILABILITY¶

This function is available since SDL 3.2.0.