(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_WriteStorageFile

Synchronously write a file from client memory into a storage container.

Header File

Defined in <SDL3/SDL_storage.h>

Syntax

int SDL_WriteStorageFile(SDL_Storage *storage, const char *path, const void *source, Uint64 length);

Function Parameters

storage a storage container to write to
path the relative path of the file to write
source a client-provided buffer to write from
length the length of the source buffer

Return Value

Returns 0 if the file was written, 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