(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable 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

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

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 0 if the file was read, a negative value otherwise; call SDL_GetError() for more information.

Version

This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryStorage