SDL_ReadStorageFile - Man Page

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

Synopsis

#include <SDL3/SDL_storage.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

for more information.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_GetStorageFileSize(3), SDL_StorageReady(3), SDL_WriteStorageFile(3)

Referenced By

SDL_GetStorageFileSize(3), SDL_OpenFileStorage(3), SDL_OpenStorage(3), SDL_OpenTitleStorage(3), SDL_OpenUserStorage(3), SDL_WriteStorageFile(3).

SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS