SDL_ReadStorageFile

Synchronously read a file from a storage container into a client-provided buffer.

Header File

Syntax

bool SDL_ReadStorageFile(SDL_Storage *storage, const char *path, void *destination, Uint64 length);

Function Parameters

SDL_Storage *	storage	a storage container to read from.
const char *	path	the relative path of the file to read.
void *	destination	a client-provided buffer to read the file into.
Uint64	length	the length of the destination buffer.

Return Value

(bool) Returns true if the file was read or false on failure; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 3.2.0.