SDL_ReadIO - Man Page
Read from a data source.
Header File
Defined in SDL3/SDL_iostream.h
Synopsis
#include "SDL3/SDL.h" size_t SDL_ReadIO(SDL_IOStream *context, void *ptr, size_t size);
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.
Return Value
Returns the number of bytes read, or 0 on end of file or other failure; call SDL_GetError () for more information.
Thread Safety
This function is not thread safe.
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_WriteIO(3), ·(3), SDL_GetIOStatus(3)
Referenced By
SDL_IOFromConstMem(3), SDL_IOFromDynamicMem(3), SDL_IOFromFile(3), SDL_IOFromMem(3), SDL_WriteIO(3).