(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_WriteStorageFile

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

Header File

Defined in <SDL3/SDL_storage.h>

Syntax

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

Function Parameters

SDL_Storage *	storage	a storage container to write to.
const char *	path	the relative path of the file to write.
const void *	source	a client-provided buffer to write from.
Uint64	length	the length of the source buffer.

Return Value

(bool) Returns true if the file was written or false on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetStorageSpaceRemaining
• SDL_ReadStorageFile
• SDL_StorageReady

---

CategoryAPI, CategoryAPIFunction, CategoryStorage

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