SDL_ReadStorageFile - Synchronously read a file from a storage container into a client-provided buffer.
Contents
Availability
This function is available since SDL 3.2.0.
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.
Header File
Defined in SDL3/SDL_storage.h
Name
SDL_ReadStorageFile - Synchronously read a file from a storage container into a client-provided buffer.
Return Value
Returns true if the file was read or false on failure; call
SDL_GetError () for more information.
See Also
•(3), SDL_GetStorageFileSize(3), •(3), SDL_StorageReady(3), •(3), SDL_WriteStorageFile(3) Simple Directmedia Layer SDL 3.2.10 SDL_ReadStorageFile(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_ReadStorageFile(SDL_Storage*storage,constchar*path,void*destination,Uint64length);
