SDL_GetIOStatus - Man Page

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

This function is not thread safe.

Availability

This function is available since SDL 3.2.0.

Referenced By

SDL_ReadIO(3), SDL_WriteIO(3).

SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS