(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_ReadStorageFile

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

Header File

Defined in <SDL3/SDL_storage.h>

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.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetStorageFileSize
• SDL_StorageReady
• SDL_WriteStorageFile

---

CategoryAPI, CategoryAPIFunction, CategoryStorage

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.