Man page - sdl_readstoragefile(3)
Packages contains this manual
Manual
SDL_ReadStorageFile
NAMEHEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY
SEE ALSO
NAME
SDL_ReadStorageFile - Synchronously read a file from a storage container into a client-provided buffer.
HEADER FILE
Defined in SDL3/SDL_storage.h
SYNOPSIS
#include "SDL3/SDL.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
Returns true if the file was read or false on failure; call
SDL_GetError () for more information.
AVAILABILITY
This function is available since SDL 3.2.0.
SEE ALSO
• (3), SDL_GetStorageFileSize (3), • (3), SDL_StorageReady (3), • (3), SDL_WriteStorageFile (3)