SDL_ReadIO - Read from a data source.
Contents
Availability
This function is available since SDL 3.2.0.
Description
This function reads up size bytes from the data source to the area pointed at by ptr . This function may
read less bytes than requested.
This function will return zero when the data stream is completely read, and
SDL_GetIOStatus () will return
SDL_IO_STATUS_EOF . If zero is returned and the stream is not at EOF, SDL_GetIOStatus () will return a
different error value and SDL_GetError () will offer a human-readable message.
Function Parameters
context
a pointer to an SDL_IOStream
structure.
ptr a pointer to a buffer to read data into.
size the number of bytes to read from the data source.
Header File
Defined in SDL3/SDL_iostream.h
Name
SDL_ReadIO - Read from a data source.
Return Value
Returns the number of bytes read, or 0 on end of file or other failure; call SDL_GetError () for more
information.
See Also
•(3), SDL_WriteIO(3), •(3), SDL_GetIOStatus(3) Simple Directmedia Layer SDL 3.2.10 SDL_ReadIO(3)
Synopsis
#include"SDL3/SDL.h"size_tSDL_ReadIO(SDL_IOStream*context,void*ptr,size_tsize);
Thread Safety
This function is not thread safe.
