SDL Wiki
(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

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

(int) 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


[ edit | delete | history | feedback | raw ]

[ 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.