SDL_ReadStorageFile - Man Page
Synchronously read a file from a storage container into a client-provided buffer.
Header File
Defined in SDL3/SDL_storage.h
Synopsis
#include "SDL3/SDL.h" bool SDL_ReadStorageFile(SDL_Storage *storage, const char *path, void *destination, Uint64 length);
Description
The value of length must match the length of the file exactly; call
SDL_GetStorageFileSize () to get this value. This behavior may be relaxed in a future release.
Function Parameters
- storage
a storage container to read from.
- path
the relative path of the file to read.
- destination
a client-provided buffer to read the file into.
- length
the length of the destination buffer.
Return Value
Returns true if the file was read or false on failure; call
SDL_GetError () for more information.
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_GetStorageFileSize(3), ·(3), SDL_StorageReady(3), ·(3), SDL_WriteStorageFile(3)
Referenced By
SDL_GetStorageFileSize(3), SDL_OpenFileStorage(3), SDL_OpenStorage(3), SDL_OpenTitleStorage(3), SDL_OpenUserStorage(3), SDL_WriteStorageFile(3).